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

contributing documentation overhaul #517

Merged
merged 11 commits into from
Dec 5, 2024

Conversation

jcgsville
Copy link
Contributor

@jcgsville jcgsville commented Dec 3, 2024

Description

Did an overhaul on Contributing docs to make them up-to-date with the latest changes and provide info on the things I had to figure out myself.

I also fixed the yarn website script, which was not working, and I added the yarn cli script. I'm not deeply opinionated about having yarn cli, so if you think it's not useful enough to add to package.json scripts, I'm happy to update it and update the docs.

Also, when I ran docker compose I got this warning, so I removed the version line as instructed.

WARN[0000] /path/to/graphile/worker/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion 

Checklist

  • My code matches the project's code style and yarn lint:fix passes.

website/docs/contributing.md Outdated Show resolved Hide resolved
@jcgsville jcgsville changed the title WIP: update contributing docs with correct docker compose commands & yarn 1.x update contributing docs with correct docker compose commands & yarn 1.x Dec 5, 2024
@jcgsville jcgsville marked this pull request as ready for review December 5, 2024 01:06
@jcgsville jcgsville changed the title update contributing docs with correct docker compose commands & yarn 1.x contributing documentation overhaul Dec 5, 2024
@benjie benjie merged commit e1b85a9 into graphile:main Dec 5, 2024
7 checks passed
@jcgsville jcgsville deleted the chandler/update-docker-compose-docs branch December 5, 2024 15:46
@jcgsville
Copy link
Contributor Author

Thanks for the additions and corrections, @benjie

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.

2 participants