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

Move docs to wiki and document testing and creating migrations #321

Open
MarkKoz opened this issue Jan 1, 2020 · 0 comments
Open

Move docs to wiki and document testing and creating migrations #321

MarkKoz opened this issue Jan 1, 2020 · 0 comments

Comments

@MarkKoz
Copy link
Member

@MarkKoz MarkKoz commented Jan 1, 2020

Move docs

  • Migrate deployment docs to a new sub-article.
    • Check how relevant they still are (ask the author, @jchristgit)
    • Deployment docs are low priority.
  • Migrate configuration docs to a new table in the environment variables section.

Tests

  • Document how to run tests.
  • Possibly document how to write tests. See python-discord/bot#716 for more details.

Migrations

  • Document how to create migrations and when new ones are necessary.
  • Document how to name migrations well rather than using the automatically generated names.
  • Document how to deal with conflicts i.e. new migrations from upstream.

Other

  • Document how to re-build the Docker image in case dependencies are changed.
@MarkKoz MarkKoz changed the title Migrate docs to wiki and document testing and creating migrations Move docs to wiki and document testing and creating migrations Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.