-
Notifications
You must be signed in to change notification settings - Fork 31
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
New 'Repos' page and consolidation of 'Apps' page #3510
Conversation
6550429
to
6af8246
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works locally for me ✅.
Great to see the emerging focus on repos vs. apps 🚀.
Do we really need the "apps" page anymore? All the info that's on it can be seen on the new "repos" page. Seeing both of them, I half expected the links on the "apps" page to go to the live app, but what we really mean by "app" is "app repository", not the running version of it. I don't feel strongly about this, though. What are your thoughts?
Looking at the code itself, do you think it's worth adding some tests for the new / updated pages? There's some precedent for it but I also get that this isn't that much of a change from what was there before. Otherwise, all my comments are just some ideas for how to polish the new layout / content a bit.
47a8216
to
2455953
Compare
This creates a new 'repos.html' page, which is intended to be a catch-all page similar to the 'apps.html' page, listing all known GOV.UK repositories: ![repos page screenshot](https://user-images.githubusercontent.com/5111927/166255289-07212299-65d5-43f4-8178-0455c14699ff.png) The previous implementation of the apps.html page was not a great design; it added many links to the sidebar, which had to be scrolled to see all the available apps. Better to put this information on the main page itself, and default to the `layout` layout, which automatically parses page headings: https://tdt-documentation.london.cloudapps.digital/configure_project/frontmatter/#layout Before: ![before](https://user-images.githubusercontent.com/5111927/166255046-8042ab9d-4065-4f02-9479-6d16b86dcd99.png) After: ![after](https://user-images.githubusercontent.com/5111927/167613943-dbdd3d89-9e86-44ed-8528-422cd4a394f1.png) Now, all 'grouped' information is available in one place (teams, types, hosting), and the sidebar is used for an arguably better purpose: anchor links to the relevant parts of the page. This also removes the need for a redundant 'by-teams.html' page, as the info is already captured on the apps.html page. The result is a simpler codebase and more easily findable information.
Co-authored-by: Ben Thorner <benthorner@users.noreply.github.com>
Co-authored-by: Ben Thorner <benthorner@users.noreply.github.com>
2455953
to
6aa48fe
Compare
Thanks for the review, @benthorner! I've addressed all the individual comments if you'd like to re-review 👀
Part of the reason to properly support the concept of 'repos' rather than just 'apps' was the confusion some teams were facing when looking at what used to be So for that reason, I think it's still worth having a distinct grouping of 'apps' vs 'repos'.
Yes, that's a good point. I think once this is merged we could look at making the app and app-overview pages a bit more tailored to apps. Don't think it's a blocker for this PR though.
The existing tests are really just linting: redirect_spec.rb checks that redirects aren't missing their |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ready to 🚢.
I like the argument of keeping the page with a view to tailoring it in future. And in the meantime the mysterious "stakeholders" can still benefit from it 😜.
It improves the introduction and makes the section that follows cleaner and more consistent with the other 'grouped by' sections. See #3510 (comment)
Alongside the refactoring in #3509, there are some related visual improvements. Here is a summary of the changes:
Addition of a 'Repos' page
#3481 saw the addition of a 'repos.json' alongside the longstanding 'apps.json' functionality. So it seems only natural that we should also want a summary page of Repos alongside our summary page of Apps.
Addition of 'Repos' link in header
See above.
Changes to 'Apps' page
The addition of the 'Repos' page led to some duplication etc, which got consolidated and visually reviewed, and eventually led to the following improvements to the Apps page. It removed the need for a separate 'by team' page.
Before:
After:
Removal of the 'apps by team' page
The existing page is no longer required once these changes are merged.
Trello: https://trello.com/c/oUsgzZnk/247-standardise-how-we-represent-repositories-in-the-dev-docs