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

Add CHS website updates (releases) page #407

Open
becky-gilbert opened this issue Apr 18, 2024 · 0 comments
Open

Add CHS website updates (releases) page #407

becky-gilbert opened this issue Apr 18, 2024 · 0 comments

Comments

@becky-gilbert
Copy link
Contributor

Summary

We should consider adding a documentation page that describes the updates that we make to the lookit-api site (either all production releases, or just things that might be relevant to researchers).

Description

We currently have a documentation page that lists the lookit experiment runner updates in reverse chronological order. It might be nice to do something similar with our lookit-api/website updates. We do tell researchers about updates in the Slack announcements channel, but putting the updates in a docs page would create a more organized public record of the improvements we're making to the site. It also gives us a useful set of links to send to researchers who might be confused when we make changes on the site. Another benefit is that it gives a place to publicly acknowledge and thank outside contributors.

An open question is where exactly this information would go on the documentation site. My suggestion is to create a new page called something like "CHS website updates". It might make sense to put this page in the Overview or Contributing section.

Scoping

Creating this page should not be much work. We can base the format on the Experiment Runner Releases page, and go back through the Slack announcements channel to list some of our key updates from the recent past. We would also need to add the page to the table of contents.

After the page has been created, when we do future releases, we would write up a short description of the release (the same as what we currently write in the Slack announcement channel) and add it to the page.

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

No branches or pull requests

1 participant