Skip to content

#8351 fixing inconsistency in admin's Troubleshouting page#9038

Merged
sekmiller merged 1 commit intoIQSS:developfrom
pkiraly:8351-inconsistency-in-troubleshouting-page
Oct 12, 2022
Merged

#8351 fixing inconsistency in admin's Troubleshouting page#9038
sekmiller merged 1 commit intoIQSS:developfrom
pkiraly:8351-inconsistency-in-troubleshouting-page

Conversation

@pkiraly
Copy link
Member

@pkiraly pkiraly commented Oct 7, 2022

What this PR does / why we need it:

There is an inconsistency between text and code snippet in admin guide's troubleshooting section.

I also found an extra colon in another part of the document, which makes a wrong formatting of another code snippets.

Which issue(s) this PR closes:

Closes #8351

Special notes for your reviewer:

You should build the documentation.

Suggestions on how to test this:

cd doc/sphinx-guides/
make clean
make html
firefox build/html/admin/troubleshooting.html

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

It changes only the Admin guide of the manual.

Is there a release notes update needed for this change?:

No.

Additional documentation:

the code snippet mentioned in the issue should look like this:
dataverse-8351-1-fixed

The other formatting issue looks like this now:
dataverse-8351-2-wrong

After applying this PR, it will look like this:
dataverse-8351-2-fixed

@sekmiller sekmiller merged commit b20a20f into IQSS:develop Oct 12, 2022
@pdurbin pdurbin added this to the 5.13 milestone Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inconsistency in Troubleshouting page

3 participants