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

Add docs directory for beginning of developer's guide #365

Closed
clshaw01 opened this issue Sep 5, 2024 · 2 comments · Fixed by #369
Closed

Add docs directory for beginning of developer's guide #365

clshaw01 opened this issue Sep 5, 2024 · 2 comments · Fixed by #369
Assignees
Labels

Comments

@clshaw01
Copy link
Contributor

clshaw01 commented Sep 5, 2024

In the project's output, include subdirectories for developer's handbook, etc.

Initial structure should be (suggested):

  • /docs/development (ask Christine for sample docs)

    • /getting-started
    • /code-quality
    • /release-process
    • /git-workflow
    • /pr-workflow
    • /repo-settings
  • /docs/project-overview

  • /docs/architecture

  • /docs/er-diagram

  • /docs/secrets (how to manage)

  • /docs/monitoring

@hillairet
Copy link
Member

In the interest of making a PR now and keeping it small and easy to review, I won't introduce new content such Code Quality or PR workflow. Each of these items deserve to be their own PR so they are properly reviewed.

I just added the architecture and project overview pages. The ER diagram feels a little premature as well. This is something that should ideally be generated from the code to always be up to date so best to add it when we have a solution to generate it automatically.

github-actions bot pushed a commit that referenced this issue Oct 30, 2024
## [1.17.2](v1.17.1...v1.17.2) (2024-10-30)

### Bug Fixes

* Do not change the ownership of the bind mounted directory ([#414](#414)) ([2b4469e](2b4469e)), closes [#413](#413)

### Documentation

* change readme structure ([#369](#369)) ([abd3b64](abd3b64)), closes [#365](#365)
Copy link

🎉 This issue has been resolved in version 1.17.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants