Project

General

Profile

Architecture #12907

Build a centralized place for doc: docs.rudder.io

Added by Alexis MOUSSET 11 months ago. Updated 4 months ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Effort required:

Description

Convert the sources to build the reference doc with antora.

Previous docs will be by buildable anymore (webhelp, 1-page html, pdf, epub) for now.

pdf and epub version may be added in the future using asciidoctor.


Subtasks

User story #12630: Add a "first steps" guide for new usersReleasedBenoît PECCATTEActions
User story #12699: Add content is the get-started guideReleasedAlexis MOUSSETActions
User story #12871: Build antora build errorReleasedFrançois ARMANDActions
User story #12873: Improve get-started contentReleasedFrançois ARMANDActions
User story #13000: Improve get-started contentReleasedFrançois ARMANDActions
User story #12876: Create a Rudder theme for antoraRejectedRaphael GAUTHIERActions
User story #12877: Add relevant links to antora headerReleasedFrançois ARMANDActions
Architecture #12962: Build error after parent changeReleasedFrançois ARMANDActions
User story #12963: Add a landing page for the new docReleasedBenoît PECCATTEActions
User story #12964: Fix internal linksReleasedFrançois ARMANDActions
Bug #12965: Fix graphviz integrationReleasedBenoît PECCATTEActions
User story #12974: Add docsearch integration for new docRejectedAlexis MOUSSETActions
Architecture #12979: rudder man page now uses .adoc extensionReleasedFrançois ARMANDActions
User story #12981: Improve new doc interfaceReleasedAlexis MOUSSETActions
Architecture #13034: Missing faviconReleasedBenoît PECCATTEActions
Architecture #13050: Custom 404 pageRejectedAlexis MOUSSETActions
Architecture #13051: Indicate more clearly that there are different documents in the same siteReleasedAlexis MOUSSETActions
Bug #13055: Avoid "Untitled" in page title RejectedAlexis MOUSSETActions
Architecture #13056: Fix syntax of mustache block in rudder by exampleRejectedAlexis MOUSSETActions
Bug #13062: Level 4 titles are not visibleReleasedRaphael GAUTHIERActions
Architecture #13068: Use 5.0 branchReleasedBenoît PECCATTEActions
Architecture #13076: Update header barReleasedBenoît PECCATTEActions
Bug #13092: Fix code blocks inclusion ReleasedBenoît PECCATTEActions
Architecture #13093: Add a search fieldReleasedBenoît PECCATTEActions
Architecture #13132: Make a nice search field and resultsReleasedAlexis MOUSSETActions
Bug #13095: Correctly generate nav in the reference docReleasedBenoît PECCATTEActions
Bug #13122: Remove underscores from the end of the idReleasedBenoît PECCATTEActions
Architecture #13099: Deduplicate rudder-by-exampleReleasedBenoît PECCATTEActions
Architecture #13102: Sensible sources/branches for release and dev buildsReleasedBenoît PECCATTEActions
Architecture #13104: Same as parent for masterReleasedBenoît PECCATTEActions
Architecture #13105: Need to quote versionReleasedBenoît PECCATTEActions
Architecture #13106: "Edit this page" does not work for reference manualRejectedAlexis MOUSSETActions
Architecture #13110: Make different targets for docsReleasedAlexis MOUSSETActions
Architecture #13115: Use tar.gz instead of zipReleasedBenoît PECCATTEActions
Architecture #13114: Use antora doc in rudder-webapp buildReleasedAlexis MOUSSETActions
Architecture #13123: Build broken by parent issueReleasedBenoît PECCATTEActions
Architecture #13128: Change doc url to archivesReleasedBenoît PECCATTEActions
Architecture #13121: Reorder sources in the explore panelRejectedActions
Architecture #13126: Generate redirection info to latest stable docReleasedBenoît PECCATTEActions
Architecture #13130: Add links to 4.1 and 4.3 docsReleasedBenoît PECCATTEActions
Architecture #13134: Make a nice home pageReleasedNicolas CHARLESActions
Architecture #13200: Make the home page beautifulReleasedAlexis MOUSSETActions
Architecture #13281: Fix install links in home pageReleasedFrançois ARMANDActions
Architecture #13137: Make plugin doc build with 5.0 docReleasedAlexis MOUSSETActions
Architecture #13306: Git repository not initialised in plugin directoryReleasedVincent MEMBRÉActions
Architecture #13308: Missing mkdir in parentReleasedBenoît PECCATTEActions
Architecture #13309: nav is not generatedReleasedBenoît PECCATTEActions
Architecture #13140: Build a .htacces including redirectReleasedBenoît PECCATTEActions
Architecture #13156: Upgrade ui from default themeReleasedBenoît PECCATTEActions
Bug #13208: Fix UI bugs after css updateReleasedAlexis MOUSSETActions
Architecture #13161: Use first level title for each page in get-started and by-exampleReleasedBenoît PECCATTEActions
Architecture #13162: Redo page splitReleasedFrançois ARMANDActions
Architecture #13163: Improve doc build configReleasedBenoît PECCATTEActions
Architecture #13167: Broken link in dev doc after parentReleasedNicolas CHARLESActions
Architecture #13177: Finish initial version of get-started guideReleasedFrançois ARMANDActions
Architecture #13448: Finish initial version of get-started guideReleasedFrançois ARMANDActions
Architecture #13205: Use new links for GM docReleasedFrançois ARMANDActions
Bug #13234: Broken link in policy mode docRejectedAlexis MOUSSETActions
Architecture #13239: Keep embedded version for publicationReleasedBenoît PECCATTEActions
Architecture #13240: Use the right file organization in build directoryReleasedBenoît PECCATTEActions
Architecture #13242: Parent issue breaks the buildReleasedBenoît PECCATTEActions
Architecture #13241: Use the right file organizationin build directoryRejectedAlexis MOUSSETActions
Bug #13248: Current page display does not work in reference docRejectedAlexis MOUSSETActions
Bug #13252: Fix the doc: intro and installation sectionsReleasedFrançois ARMANDActions
Bug #13269: Continue the doc cleaning on usage chapterReleasedFrançois ARMANDActions
Architecture #13284: Continue the doc cleaning on administration chapterReleasedFrançois ARMANDActions
Architecture #13438: Continue the doc cleaning on reference chapterReleasedFrançois ARMANDActions
Bug #13260: The menu view should stay on the currently selected pageRejectedRaphael GAUTHIERActions
Architecture #13264: Rework header menuReleasedFrançois ARMANDActions
Architecture #13271: Improve appearance of text blocksReleasedAlexis MOUSSETActions
Architecture #13445: Use new doc links in RudderReleasedAlexis MOUSSETActions
Architecture #13449: Make the current -> 5.0 redirect work in RudderReleasedBenoît PECCATTEActions
Architecture #13477: Fix rudder by example internal linksReleasedFrançois ARMANDActions
Bug #13485: Correctly generate htaccess in archives ReleasedBenoît PECCATTEActions
Bug #13486: Parent patch does not workReleasedBenoît PECCATTEActions
Bug #13490: htaccess for embedded doc needs to be differentReleasedBenoît PECCATTEActions
Architecture #13493: Allow loading .htaccess from Rudder docReleasedBenoît PECCATTEActions
Architecture #13501: Update theme to 1.1.1ReleasedFrançois ARMANDActions
Architecture #13504: The menu should point to gitter instead of IRCReleasedFrançois ARMANDActions
Architecture #13526: Add information about Rudder subscription to the docReleasedFrançois ARMANDActions

Related issues

Related to Rudder - User story #12993: Add previous/next page linksRejectedActions
Related to Rudder - Architecture #12995: Node compliance is displayed too early in the getting startedNewActions
Related to Rudder - Architecture #13133: Update the development doc for the documentationNewActions
Related to Rudder - Architecture #13135: Add search engine for embedded docNewActions
Related to Rudder - Architecture #13253: Add an index page for the reference manualNewActions

Associated revisions

Revision 0d268a72 (diff)
Added by Alexis MOUSSET 10 months ago

Fixes #12907: Move reference manual to antora

History

#1

Updated by Alexis MOUSSET 11 months ago

  • Status changed from New to In progress
#5

Updated by Alexis MOUSSET 11 months ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis MOUSSET to François ARMAND
  • Pull Request set to https://github.com/Normation/rudder-doc/pull/435
#7

Updated by Rudder Quality Assistant 10 months ago

  • Status changed from Pending technical review to Discussion
  • Assignee changed from François ARMAND to Alexis MOUSSET
#8

Updated by Alexis MOUSSET 10 months ago

  • Status changed from Discussion to Pending technical review
  • Assignee changed from Alexis MOUSSET to François ARMAND
#9

Updated by Alexis MOUSSET 10 months ago

  • Status changed from Pending technical review to Pending release
#10

Updated by Alexis MOUSSET 10 months ago

  • Subject changed from Move reference manual to antora to Build a centralized place for doc: docs.rudder.io
#12

Updated by Vincent MEMBRÉ 9 months ago

This bug has been fixed in Rudder 5.0.0~beta1 which was released today.
Changelog
#13

Updated by François ARMAND 4 months ago

#14

Updated by François ARMAND 4 months ago

  • Related to Architecture #12995: Node compliance is displayed too early in the getting started added
#15

Updated by François ARMAND 4 months ago

#16

Updated by François ARMAND 4 months ago

#17

Updated by François ARMAND 4 months ago

#18

Updated by François ARMAND 4 months ago

  • Status changed from Pending release to Released

Also available in: Atom PDF