Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • S swh-docs
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 98
    • Issues 98
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 3
    • Merge requests 3
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Platform
  • Development
  • swh-docs
  • Issues
  • #4496
Closed
Open
Issue created Sep 06, 2022 by Benoit Chauvet@bchauvetMaintainer

Refactor the doc.s.o structure

The actual documentation is divided in 3 sphinx projects :

  • docs ( = devel)
  • sysadm
  • user

For the landing page, I've created a 4th sphinx project, called "general"

Having 4 sphinx projects, linked together by intersphinx, is a source of templates duplication and limits to cross-applications tables of contents (for the landing page in particular)

In order to improve the documentation management, we could merge it in one unique sphinx project.

Before we validate this option, the consequences and repercussions are to be considered, amongst them :

  • possibility to make partial builds
  • page anchors deduplication (+ update references)

list to be completed...


Migrated from T4496 (view on Phabricator)

Assignee
Assign to
Time tracking