Uh oh!
There was an error while loading. Please reload this page.
Rewrite the README to be clear and succinct - #246
Conversation
ghickman
commented
Apr 22, 2025
@meshy – this is a rather drastic minimisation of the current README's content, but I think most of that is no longer relevant now that ccbv.co.uk is widely known, and the GCBVs have been around for 12 (!) years. What do you think? Am I missing anything? Could I take more out? Not relevant for this PR but I think we can script even more of the tooling around the project when I look at it from a docs perspective! |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| ## Add data for new versions of Django | ||
| 1. Update the `requirements.prod.in` file to pin the required version of Django | ||
| 2. Run `make compile` to compile this change to `requirements.prod.txt`. | ||
| 4. Update the project's code to run under the target version of Django, if necessary | ||
| 5. Run `python manage.py populate_cbv` to introspect the running Django and populate the required objects in the database | ||
| 6. Run `python manage.py fetch_docs_urls` to update the records in the database with the latest links to the Django documentation | ||
| 7. Export the new Django version into a fixture with: `python manage.py cbv_dumpversion x.xx > cbv/fixtures/x.xx.json` |
There was a problem hiding this comment.
Issue: We'll need to add something here about the extra manual step, or find a way to automate it. We can discuss this IRL.
This modernises the project's README to match the current state of the project (ie dropping tools we should look at), tidies up the prose to be more succinct, and splits out contribution docs to CONTRIBUTING.md. The contributor docs have been streamlined to point to the `make` commands where possible. I've also added a section from #245 on where the project is going. It's a long piece of work so my hope is this sets expectations without making the maintainers feel bad when folks raise a PR for defunct or soon-to-be-removed code paths.
This modernises the project's README to match the current state of the project (ie dropping tools we should look at), tidies up the prose to be more succinct, and splits out contribution docs to CONTRIBUTING.md. The contributor docs have been streamlined to point to the `make` commands where possible. I've also added a section from #245 on where the project is going. It's a long piece of work so my hope is this sets expectations without making the maintainers feel bad when folks raise a PR for defunct or soon-to-be-removed code paths.
This modernises the project's README to match the current state of the project (ie dropping tools we should look at), tidies up the prose to be more succinct, and splits out contribution docs to CONTRIBUTING.md.
The contributor docs have been streamlined to point to the
makecommands where possible. I've also added a section from #245 on where the project is going. It's a long piece of work so my hope is this sets expectations without making the maintainers feel bad when folks raise a PR for defunct or soon-to-be-removed code paths.Fix: #239