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

Document how the website is updated for releases #262

Open
fingolfin opened this issue Feb 10, 2022 · 1 comment
Open

Document how the website is updated for releases #262

fingolfin opened this issue Feb 10, 2022 · 1 comment

Comments

@fingolfin
Copy link
Member

fingolfin commented Feb 10, 2022

Right now, just looking at this repository it is not clear how things are updated for a releases. We should document this in the repository, even if it just means pointing to docs somewhere else.

Some specific ideas:

  • the README.md should talk about it
  • relevant is of course the dev/releases/update_website.py script in the gap repository, so mention it, and also its README
  • all generated files should have at their top a comment which indicates they are generated, should not be modified by hand, and ideally also how they were generated. E.g. "DO NOT EDIT THIS FILE MANUALLY. It was generated by the update_website.py script from the gap repository"
  • pointers at the relevant CI jobs might also be helpful
@fingolfin
Copy link
Member Author

If all goes well then the sync workflow will detect a new release and open a PR here. Then it can be merged. This leaves updating docs.gap-system.org and files.gap-system.org -- I just left a comment in #250 which discusses how this could then be triggered by merging that PR

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

No branches or pull requests

2 participants