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
xSACdb
xSACdb
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 132
    • Issues 132
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 3
    • Merge Requests 3
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Will Pimblett
  • xSACdbxSACdb
  • Wiki
  • Home

Last edited by Will Pimblett Feb 07, 2017
Page history

Home

xSACdb Documentation

Should we move documentation from the repo into here?

Pros

  • Access everywhere: in GitLab, published separately and in application
  • Easier to edit, done in browser or lightweight on desktop rather than having to wrangle entire project to do. Should lead to more documentation being written.
  • Separate documentation commits from code commits.

Cons

  • Not bound to versions. People running old xSACdb may get out of date docs (can we negate this by setting a documentation commit to peg the release to?)
  • Introduces another repo, and git submodules.
  • Hierarchical navigation, how would this work?

Weighing Up

We probably should. Need to think about navigation.

Clone repository
User Documentation
  • Accounts
  • The Dashboard
  • My Profile
  • Training Records
  • Dive Sites
Administrator Documentation
  • Member Roles