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

Docs: update all documentation #944

Merged
merged 2 commits into from
Jan 16, 2025

Conversation

katie-gardner
Copy link
Contributor

@katie-gardner katie-gardner commented Jan 16, 2025

Overview

Ran through all the documentation looking for anything outdated or missing and updated anything I found

Also removed some legacy migration scripts which have since been replaced with the export-processor and contentful-managment import process

Changes

  • Since first implementing redis we've improved the process so you no longer need to manually cache each contentful usage - so I've removed this from Conventions.MD
  • The seed test database, isn't really being used the way it was first created, but is now a great way to have a local test database, so I've updated docs accordingly, renaming the project could be done to, depending on the plan for its future usage
  • Removed a couple of other sentences referring to content in the database, which is no longer the case
  • Added a couple of additional links to help onboarding devs find the relevant READMEs more easily

How to review the PR

Check that all the updated documentation is correct and makes sense

Checklist

Delete any rows that do not apply to the PR.

@jimwashbrook jimwashbrook self-requested a review January 16, 2025 09:32
@katie-gardner katie-gardner merged commit be379d8 into development Jan 16, 2025
11 checks passed
@katie-gardner katie-gardner deleted the docs/update-all-documentation branch January 16, 2025 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants