documentation search/replace glitches after mkdocs transition

[jodygarnett]

Describe the bug

Some document glitches have occurred, look to be search and replace problems, during transition to mkdocs
#7286

Additional context

mkdocs: https://docs.geonetwork-opensource.org/4.2/administrator-guide/managing-users-and-groups/authentication-mode/#environment-variable-and-meaning

GEONETWORK_SECURITY_TYPE

Should be ct.

sphinx: https://github.com/geonetwork/doc/blob/dd1a7a6f2fc7b90f206eaadd1ba6271499a0647c/source/administrator-guide/managing-users-and-groups/authentication-mode.rst#L559

GEONETWORK_SECURITY_TYPE

Should be openidconnect.

[jodygarnett]

@davidblasby this is an alarming find, we may need to check if the issue is widespread.

[davidblasby]

The GN documentation looks a bit messed up - someone was asking about some OIDC stuff.

Looking here - https://docs.geonetwork-opensource.org/4.2/administrator-guide/managing-users-and-groups/authentication-mode/#environment-variable-and-meaning

I see:

Notice the text that highlighted are only 2 characters long.

However, going here -
https://github.com/geonetwork/doc/blob/dd1a7a6f2fc7b90f206eaadd1ba6271499a0647c/source/administrator-guide/managing-users-and-groups/authentication-mode.rst#L559

I see:

... Which looks correct (full names)

[jodygarnett]

So it appears to be character literals not matching well - and only collecting the last two characters. I hope it is not all through the documentation.

[archaeogeek]

I think this issue might be quite widespread- I've just found another example in https://docs.geonetwork-opensource.org/4.2/install-guide/configuring-database/#configuring-a-database-via-environment. What would be the best approach to fix- do each one as identified? (If so is it now just a question of fixing the affected markdown file?)

[davidblasby]

I forwarded your email to jody garnett - he is looking into it. dave

[jodygarnett]

Oh thanks @archaeogeek - I am a bit disheartened by this feedback being caught so late in the game.

The symptom seems to be characters:

`..`

That is a string literal that ends up with only two characters.
I am not sure how many of these there are.

• If it is a small number we could fix by hand (sounds terrible) but it would preserve manual changes made since conversion
• If it is a medium number I could "reconvert" the pages found with the problem and prepare a a pull-request for review
• If it is a large number I reconvert everything, and then we check the other way, what has been edited by hand since conversion

[jodygarnett]

So what is the answer?

• 150 occurrences in 32 files

I guess I need to "reconvert 32 pages and make a pull-request.

[archaeogeek]

@jodygarnett I'm happy to manually change any that I find, if that helps

[jodygarnett]

Adjusting search to grep results in 87 in 17 files

\s`\w\w`\s

After:

Via the schema plugin form configuration it is an option to configure a thesaurus to be used for a specific Anchor element.

Before:

Via the schema plugin form configuration it is an option to configure a thesaurus to be used for a specific or element

[jodygarnett]

@archaeogeek / @MichelGabriel this is a small enough list to handle one at a time by comparing:

• https://github.com/geonetwork/core-geonetwork/tree/main/docs/manual/docs
• https://github.com/geonetwork/doc/tree/4.0.x/source

I have started a branch here: https://github.com/geonetwork/core-geonetwork/tree/docs-glitch

If you have capacity to assist it would be timely.

[MichelGabriel]

Fixed the errors in docs/manual/docs/administrator-guide/managing-users-and-groups/authentication-mode.md

[jodygarnett]

Fixed the errors in docs/manual/docs/administrator-guide/managing-users-and-groups/authentication-mode.md

Thanks @MichelGabriel and @archaeogeek for working on this, I created a pull request #7687 with a checklist of each file to be fixed.

[jodygarnett]

Folks I am having a terrible time with GitHub and managing @archaeogeek pull-requests.

I am sorry @archaeogeek I merged #7687 because you were not using it. And then I noticed that your pull-requests, were against that other docs-glitch branch, which was just deleted, so now your pull-requests are broken.

I am going to try and restore that branch, but yeah this is a struggle to work together.

What am I missing? How does core-geonetwork community work on an activity together?

[jodygarnett]

Okay @archaeogeek I have managed to recover all your commits.

Two files have things outstanding:

• authentication.mode (@MichelGabriel got most of these but a couple remain

  The LDAPRoleConverterGroupNameParser, which works the same as the original LDAP configuration. It uses a regular expression to parse the LDAP group name into a GeoNetwork Group/Profile. This will convert the LDAP role OR into the GeoNetwork group AL with Profile r.

• creating-group.md

  The administrator can create new groups of users. User groups could correspond to logical units within an organisation, for example es, re, nd, er, th and so on.

[jodygarnett]

This has been addressed for main and 4.2 branch.

[jodygarnett]

Here is a backport for the 3.12.x branch

[jodygarnett]

This is now fixed, verified with the following:

• https://docs.geonetwork-opensource.org/4.4/user-guide/workflow/life-cycle/
• https://docs.geonetwork-opensource.org/4.2/user-guide/workflow/life-cycle/
• https://docs.geonetwork-opensource.org/3.12/user-guide/workflow/life-cycle/