Formatting fixes, whitespace, links, rename files

Would you like this branch to temporarily build the actual documentation site, then we could check the built pages. I can add that here if it would be helpful.

There could be a few conflicts here, so I suggest we get MR2 and MR4 merged first, then see where we are.

I have aligned the pipeline changes with 'main' so we now run cspell and do not allow it to fail.

The pipeline failed but it seems that some of the spelling errors are in files that have been renamed. I updated the issue fork (using the gitlab UI when browing the repository) but that has not solved it. It is only two words (mymodule and docblock) and we can use the comparison in the MR to undo those particular line changes, and even make code suggestions that can be applied within the MR.

No problem. I used the MR suggestions, to make it easier to see what was original and which new changes needed to be reverted.

Point 1 in PHP -> Quotes does not seem to be rendered properly. I have not done an exhaustive review of all the pages, but just mentioning things as I spot them. But it may be good to get these renames committed soon(ish) so that we don't get rebase errors again if new issue branches are opened.

I have added links to the documentation sites, as it can be confusing having two outputs here. This is only due to the temporary override in the .gitlab-ci.yml.

I'm going to see if we can find a better way to do this in Gitlab Templates generally, so that there is only one temporary documentation site, and the "live" site would only get updated on merging into the main repo.

I think the mkdocs file was clean before, but the new links had the wrong indentation. That can be fixed easily, then we can run the eslint job. I can do that here if you like, and also remove the temporary code.

Also the phpcs job (that currently runs) can be ignored, because Gitlab Templates has been corrected to better determine if php files can be checked. On the next release of the templates this job will not run.

All jobs are green, including eslint.

Yes you are right that the yml standard for indentation is 2, and this is also enforced in the core .eslintrc.jon setting. For simple yml structures it is easy to see that two spaces are always used, but mkdocs.yml has a more complex nested structure. Here is an example which I did not change, it was alerady correct:

plugins:
  - search
  - privacy:
      enabled: !ENV [CI, false]

The "enabled" is indented 2 spaces from the start of "privacy" which actually menas 4 spaces from the '-' before the 'privacy'. But this looks fine and we did not complain. It looks at a passing glance that indentation of 2 is adhered to.

In a menu of nested links, the same principle applies:

nav:
  - Drupal Coding Standards:
      - Coding Standards: index.md

But in this case it looked wrong to you, because the new line also starts with '-'. The '- Coding' is indented 2 spaces from the start of the word 'Drupal' so it is actually 4 spaces from the '-' in front of Drupal. This may appear odd but it is what the eslint job is programmed to expect and report on. So I suggest we leave it as-is in the MR and we keep the eslint job running. The alternative is not to run eslint at all, but that would likely be worse as we'd potentially miss other violations of standards.

Actually, on #27 point (1) I did not do any of that checking. I thought you did most of it, and maybe @borisson_ on #3521924: Convert Coding Standards to GitLab pages but it wasn't me. I helped with the links, the gitlab-ci file and jobs, and the spelling and linting, but not any of the actual content of the pages.

automated-tests.md was removed but it's still in TOC

We need to lend support for #3492951: Use mkdocs --strict option to verify .md links then this could have been picked automatically and fixed before merging.

MR6 is ready for review.
The site is built at

Actually the doc site has not been rebuilt because we don't have the temporary code in place to trigger the "pages" job.

I want to make this more user-friendly for checking documentation fixes.
See #3507126: Only rebuild documentation when source has changed and
#3515276: Add documentation .md files to test the pages job.

Here is the updated site
https://coding-standards-3527545-5994d4.pages.drupalcode.org/

I've now removed the temporary code again. MR6 ready for review.

For #27.1 I repeat that it was not me who did any content review. There may have been updates to some pages since the initial commits.

There was a discussion of the tasks and sequencing on #3521924: Convert Coding Standards to GitLab pages so maybe it would be good to check against that, as the issue was closed before the tasks were marked off. It looks like most things have been covered though.

Oh yes absolutely, and no apology is needed :-) I just didn't want people to think that all the content had been checked by me. I recall that you checked some 'last updated' dates previously and there was not much (if anything) that had been changed on the existing pages.

I have added your second follow-up issue to the summary.

In the minutes #3527210: Coding Standards Meeting Wednesday 2025-06-25 0900 UTC we agreed that this issue is fixed.