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

Restructure of docs, ordered stages #285

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

reespozzi
Copy link
Contributor

This change (hackathon away day):

  • Restructures docs into stages that follow logical order for devs

Does this PR introduce a breaking change? (check one with "x")

[ ] Yes
[ ] No

@reespozzi reespozzi requested a review from a team as a code owner March 8, 2023 16:31
@timja timja requested review from linusnorton and jasonpaige March 21, 2023 09:49
Copy link
Contributor

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think troubleshooting seems better, although there is some benefit to being able to search on a single page

see my feedback below


This loses the nesting for the different platforms at the top level.

I'm not sure if we want to do that given we just implemented that very recently, cc @linusnorton

image

The concepts and standards seems a bit random with angular at the top but the content doesn't fit in there and very few need to read it.

image

Before it was at the bottom and more out of the way:

image

Database schema changes seems out of place in it's current section

Troubleshooting and guides seems duplicated with guides in new component as well?

image

image

@adusumillipraveen
Copy link
Contributor

Screenshot 2023-03-21 at 10 12 24

Links in here are broken, may be in other sections too

@adusumillipraveen
Copy link
Contributor

Screenshot 2023-03-21 at 10 17 49

will be good to have this left hand navigation for onboarding include sub sections

@adusumillipraveen
Copy link
Contributor

Screenshot 2023-03-21 at 10 26 37

Does environments belong in new components? can we move them to Path to live may be ?

@linusnorton
Copy link
Contributor

linusnorton commented Mar 21, 2023

The intention was to promote the HMCTS Way as a set of standards and documentation that apply across all of HMCTS with things like Standards that apply everywhere at the top level and the specifics of each platform in their own section. That said, it's a fairly recent change and not too late to back out of if you don't like it.

If we do stick with the current top level structure I think are things that could be moved out from Cloud Native Platform and applied across all of HMCTS. Onboarding is a good example. Going forward the expectation is that everyone using the HMCTS GitHub org. Crime are migrating across at the moment.

@github-actions

This comment has been minimized.

@github-actions

This comment was marked as outdated.

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.

5 participants