-
Notifications
You must be signed in to change notification settings - Fork 4
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 Epic #2825
Labels
Comments
This was referenced Jan 8, 2024
Gary-H9
added
the
data-platform-apps-and-tools
This issue is owned by Data Platform Apps and Tools
label
Jan 10, 2024
2 tasks
github-project-automation
bot
moved this from 🧐 To Do
to ✨ Done ✨
in Analytical Platform
Jan 18, 2024
Questions to address:
|
This issue is being marked as stale because it has been open for 60 days with no activity. Remove stale label or comment to keep the issue open. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Summary
The purpose of this epic is to improve the state of documentation for the Apps and Tools team. This activity ought to occur in three threads.
a. If possible this should be reduced, with a bias towards using one technology to display documentation. This simplicity will mean less overhead in managing the documentation going forward. (issue here)
b. Document where certain types of documentation ought to be stored. i.e. if writing a process for a user this should go in X. If writing an technical document that should be created in Y by default. (issue here)
c. Implement step a.
a. Review user facing guidance first. Ensure that guidance is correct, up to date, adds value.
b. Review internal documentation
c. Prune where possible.
List of issues in this epic
Other information
Discussions on documentation can be carried out in #data-platform-documentation-epic on Slack.
Additionally we ought to capture this ticket in this piece of work.
The text was updated successfully, but these errors were encountered: