Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🗃 Documentation: make it clear what exists and where #2106

Closed
5 tasks
Tracked by #1569
AlexVilela opened this issue Oct 27, 2023 · 1 comment
Closed
5 tasks
Tracked by #1569

🗃 Documentation: make it clear what exists and where #2106

AlexVilela opened this issue Oct 27, 2023 · 1 comment
Labels
data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools enhancement enhancing an existing feature

Comments

@AlexVilela
Copy link
Contributor

AlexVilela commented Oct 27, 2023

User Story

Define:

  • Where should all documentation go?

    • all technical docs live in data-platform tech docs
    • user guides?
    • public documentation?
    • DPAT internal documentation?
      • Team onboarding
    • Data Platform internal documentation?
    • MoJ internal documentation?
  • Stop using confluence?

    • migrate all relevant docs to data-platform tech docs
    • set a hard date for sunsetting confluence
  • Migrate relevant docs from silver dollop to data-platform tech docs

    • set a hard date for sunsetting silver dollop
  • Delete any deprecated source of information

  • Shift all private sources of info into a "dump here" section in tech docs

Value / Purpose

No response

Useful Contacts

No response

User Types

  • DPAT team member
  • Data Platform team member
  • MoJ member
  • Other government body member
  • General public

Hypothesis

If we... [do a thing]
Then... [this will happen]

Proposal

No response

Additional Information

No response

Definition of Done

Example - [ ] Documentation has been written / updated

  • All DPAT team knows where to write each type of documentation
  • Existing documentation that is deprecated is no longer accessible (Confluence spaces, etc)
  • README has been updated
  • User docs have been updated
  • Another team member has reviewed
@AlexVilela AlexVilela added data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools enhancement enhancing an existing feature 🗃 Documentation (Epic #1569) labels Oct 27, 2023
@github-actions github-actions bot mentioned this issue Oct 12, 2023
6 tasks
@AlexVilela AlexVilela changed the title 📝 Documentation: make it clear what exists and where 🗃 Documentation: make it clear what exists and where Oct 31, 2023
@Gary-H9
Copy link
Contributor

Gary-H9 commented Jan 8, 2024

Superceded by #2825

@Gary-H9 Gary-H9 closed this as completed Jan 8, 2024
@github-project-automation github-project-automation bot moved this from 🧐 To Do to ✨ Done ✨ in Analytical Platform Jan 8, 2024
@jacobwoffenden jacobwoffenden moved this to 🎉 Done in Analytical Platform Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools enhancement enhancing an existing feature
Projects
Archived in project
Development

No branches or pull requests

2 participants