Restructure documentation

[KrishnaIyer]

Summary

Restructure documentation.

Changes

• 98% of the content is just updating links and aliases.

• Update aliases. Missing aliases checked using the alias check tool:

go run util/check-aliases.go
Check 841 URLs for changes
Original: 841, Unchanged: 841, Aliased: 0, Missing: 0

• Small content improvements where necessary.

Screenshots

Notes for Reviewers

To do

• Self review
• Fill content holes
• Check that aliases are correct

Checklist

• Scope: The referenced issue is addressed, there are no unrelated changes.
• Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
• New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
• Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
• Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

[johanstokking]

Great stuff

[mjamescompton]

Looks great, much prefer the new structure but we need to create 301 redirects for every URL change so that all our search results to go to 404s.

This a pain to do with hugo and github pages as we don't have something like nginx where we can write this.

This look like the best bet. I'm just testing it now

[KrishnaIyer]

Looks great, much prefer the new structure but we need to create 301 redirects for every URL change so that all our search results to go to 404s.

This a pain to do with hugo and github pages as we don't have something like nginx where we can write this.

Hmm, I don't understand. We already use aliases and that's how we've always handled moving pages.

[mjamescompton]

@KrishnaIyer Sorry looks like they are there just did not work the first time I ran make server

[mjamescompton]

And this was the first one I checked doc/content/hardware/gateways/_index.md which alias must be automatic somehow

[HeadBoffin]

The sudden loss of the very comprehensive reference section linked on the home page that now appears scattered across the Sandbox, Cloud & Enterprise is meh boarding on WTF. I'll get used to it eventually but there will have to be a mandatory sulking period.

[johanstokking]

@HeadBoffin the Reference section became a random dump place of documentation that was relevant but we couldn't naturally fit it into good section. So we reorganized it so that we don't need to have a random dump place. What I do understand is that it would be nice to have a site map like overview, is that what you mean?

[HeadBoffin]

I really didn't see it as a random dumping ground - most of the time the stuff I needed was in the reference section - particularly the CLI ref - so I'm re-orientating myself but struggling somewhat as I'm not sure if the search has indexed all the pages as I've got lost a couple of times in the last week trying to find some pages.

A site-map couldn't hurt if it can be auto-generated. I've got some training notes I'll need to update for next week, I can use that as an opportunity to evaluate.