Fix display of GitLab pages

I can work on this, by making the 'pages' job run temporarily in an MR so we can debug and see what is going on.

This may or may not be a help, but the pages have (mostly) been built OK within this issue fork. Here's an example
https://coding-standards-3527422-de7e89.pages.drupalcode.org/composer/pa...

There only problem with the very top level page - it is still 404
https://coding-standards-3527422-de7e89.pages.drupalcode.org/
I am guessing this is because the default file is not set correctly - I will add a docs/index.md and see if that fixes it.

That worked, I added a index.md and now the top page is also shown, with no 404
https://coding-standards-3527422-de7e89.pages.drupalcode.org/

Currently, the navigation is being generated on-the-fly by file discovery in the /docs folders. This means that the menu is purely alphabetical, and every menu link is the same as page title, in title case. For exampe we get 'Php' and 'Api documentation examples'. It may be better to add a nav: section in the mkdocs.yml so we can determine the best order of pages and give proper titles. For example:

nav:
  - Home: 'index.md'
  - PHP: 'php/php.md'
      - Introduction: 'docs/php/php-coding-standards.md'
      - Namespaces: 'docs/php/namespaces.md'

etc.
I think @quieteone mentioned earlier about navigation, so this change may already be in hand on a local branch.

We can't tell if this MR will fix the real problem, but it looks like it might. When ready to merge, the temporary changes need to be undone, but this is ready for review and feedback.

@jonathan1055, thanks for setting this up to temporarily deploy the pages. That is great!

I added navigation to match the existing d.o pages and it looks correct to me. And searching is so much nicer now.

I possibly went a bit out of scope adding the navigation. I wanted to see how it all fit together.

I think the new navigation is looking a lot better, to me this looks good to commit.

@jonathan1055, thanks for setting this up to temporarily deploy the pages. That is great!

You're welcome. I note that when I run the pipeline the documentation site is built in the issue fork, which is good
https://coding-standards-3527422-de7e89.pages.drupalcode.org/

But when you run it, as a maintainer, the site is built in the "real" location, thus updating the live pages with each MR push. This is one of the reasons why the 'pages' job is set to only run on commit to the main branch. It would be nicer if all MR pipeline built the documents in the issue fork, then we could always try out changes without altering the live site. I will revert that change before you merge the MR. (NW for that)

I possibly went a bit out of scope adding the navigation. I wanted to see how it all fit together.

Not at all, that's exactly what we need to get the live site usable.

I've removed the temporary 'pages' override, and the unwanted SKIP variables. When this MR is merged (maybe using the 'merge' button this time?) then I can rebase MR2 spelling to remove the conflict.

Back to RTBC.

quietone → closed merge request !4

Thanks!