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

Restructuring documentation navigation #92

Merged
merged 26 commits into from
Nov 29, 2023

Conversation

al-fisher
Copy link
Member

@al-fisher al-fisher commented Nov 24, 2023

Closes #85

WIP - will notify when ready for review

This is good for a review now! 😸
Pretty happy with the navigation menu now, having consolidated and reshuffled all our good pages and content into a tight logical (I think) structure. And one which sets us up for expanding and writing more content - both as documentation of the core concepts and as Guides and Tutorials. Happy to hear what others think

N.B. @FraserGreenroyd I have not changed the root path of the DevOps URLs - just changing its position in the menu - but happy for you to please confirm all is as expected. 👍

I have also raised an issue here: #93 outlining some possible next steps. Some we may want to agree prioritising of

@FraserGreenroyd @alelom - happy to chat here and coordinate support finalising next steps

@al-fisher al-fisher self-assigned this Nov 24, 2023
@al-fisher
Copy link
Member Author

I have pushed a new commit replacing the white space with hyphens for a couple of the critical menu items as per suggested recommendations. This means I can decouple full and exhaustive close out of #86 from updating the READMEs in core repos and subsequently being able to merge this PR.

@al-fisher
Copy link
Member Author

Hey @alelom @FraserGreenroyd @michaelhoehn all
As above I reformatted some of folders in order get this mergeable as a series of PRs along with the READMEs in the core Repos (and meaning we wont need to do those again when we tackle #86 a some point in future.

So this is now ready for final review and hopefully merge! 😸

Cheers

@FraserGreenroyd
Copy link
Contributor

Thanks @al-fisher , have skimmed the read-me updates and look good, one minor query on the template repo one. Have planned some time tomorrow to go through this PR unless @alelom gets to it first 😄

@al-fisher
Copy link
Member Author

Thanks @FraserGreenroyd - have mopped up your comment on the template repo! cheers

Copy link
Member

@alelom alelom left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks a lot!
Just a minor suggestion and a comment on how we could solve #86 (outside this PR).

Co-authored-by: Alessio Lombardi <alessio.lombardi@burohappold.com>
@alelom alelom self-requested a review November 29, 2023 17:57
Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

I've had a run through the files today though not all, but everything looks ok from what I saw and is in line with the discussions, and I know @alelom has checked the links and stuff (even if his review doesn't state it 😄 ) as I was in contact with him during the day on this work.

Only thing missing @al-fisher is a label, but I think the documentation one will suffice so I'll pop that on for now - feel free to change it if you disagree 😄

@FraserGreenroyd FraserGreenroyd added the type:documentation Wiki, help or in code attributes label Nov 29, 2023
@al-fisher
Copy link
Member Author

Perfect thanks both
@alelom, @FraserGreenroyd

@FraserGreenroyd FraserGreenroyd merged commit a26e5d2 into main Nov 29, 2023
@FraserGreenroyd FraserGreenroyd deleted the documentation-#85-RestructuringNavigation branch November 29, 2023 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Wiki, help or in code attributes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructuring the Documentation Navigation
3 participants