Project

General

Profile

Architecture #12907

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

Added by Alexis MOUSSET 6 months ago. Updated 22 days ago.

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

Associated revisions

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

Fixes #12907: Move reference manual to antora

History

#1 Updated by Alexis MOUSSET 6 months ago

  • Status changed from New to In progress

#5 Updated by Alexis MOUSSET 6 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 Normation Quality Assistant 5 months ago

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

#8 Updated by Alexis MOUSSET 5 months ago

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

#9 Updated by Alexis MOUSSET 5 months ago

  • Status changed from Pending technical review to Pending release

#10 Updated by Alexis MOUSSET 5 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É 4 months ago

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

Also available in: Atom PDF