Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Switch to GitLab Next
  • Sign in / Register
Antora
Antora
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 172
    • Issues 172
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 35
    • Merge Requests 35
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • Antora
  • AntoraAntora
  • Issues
  • #195

Closed
Open
Opened Mar 08, 2018 by Dan Allen@mojavelinuxOwner

Allow supplemental (auxiliary) content files to be fetched and imported into the content catalog

Currently, the content aggregator focuses on gathering the primary documentation content and associating it with component versions. However, the documentation doesn't necessarily own all the content it uses. A prime example is example code and example projects. This family of content is often included in the documentation, yet hosted elsewhere. It may either be in a different directory of the same branch in the repository, or it may be in a different repository. Antora already supports gathering content from multiple repositories and branches. What's different about examples is that they aren't likely to be under an Antora project structure.

Provide a means for gathering supplemental examples and enlisting those files with the content catalog. This may be as simple as allowing a content source to be marked as providing supplemental (example) files. Antora may still look for an antora.yml file in this case, but won't impose the project structure requirements. Instead, all files just get dumped into the example family as they sit.

Antora's multi-version design mandates that it know about the content it uses (meaning files must be resolved from the virtual catalog). However, this does not mean that all files, in particular example files, have to be organized using the Antora project structure. This issue should focus on example files as these are most often the files that are contributed from a different structure.

NOTE: It's possible to implement this behavior using a custom site generator. The focus of this issue is to provide this capability out of the box.

Edited Oct 05, 2020 by Dan Allen
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
M2
Milestone
M2
Assign milestone
Time tracking
None
Due date
None
Reference: antora/antora#195