The docs from modxorg

Markdown code style issues in /ru/

Using markdownlint, the following markdown issues are flagged in the Russian translation:

ru/getting-started/server-requirements.md:6: MD012 Multiple consecutive blank lines
ru/getting-started/server-requirements.md:40: MD031 Fenced code blocks should be surrounded by blank lines
ru/getting-started/server-requirements.md:45: MD031 Fenced code blocks should be surrounded by blank lines
ru/getting-started/faqs-and-troubleshooting.md:23: MD012 Multiple consecutive blank lines
ru/getting-started/faqs-and-troubleshooting.md:24: MD012 Multiple consecutive blank lines
ru/getting-started/installation/cli.md:14: MD012 Multiple consecutive blank lines
ru/getting-started/installation/cli/config.xml.md:62: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:63: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:64: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:65: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:66: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:67: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/cli/config.xml.md:71: MD005 Inconsistent indentation for list items at the same level
ru/getting-started/installation/advanced.md:96: MD032 Lists should be surrounded by blank lines
ru/getting-started/installation/git.md:50: MD012 Multiple consecutive blank lines
ru/getting-started/installation/git.md:18: MD034 Bare URL used
ru/getting-started/installation/git.md:26: MD034 Bare URL used
ru/getting-started/installation/git.md:30: MD037 Spaces inside emphasis markers
ru/getting-started/installation/standard.md:110: MD032 Lists should be surrounded by blank lines
ru/getting-started/installation/standard.md:67: MD036 Emphasis used instead of a header
ru/getting-started/installation/standard.md:72: MD036 Emphasis used instead of a header
ru/getting-started/installation/standard.md:88: MD036 Emphasis used instead of a header
ru/getting-started/installation.md:6: MD012 Multiple consecutive blank lines
ru/getting-started/installation.md:7: MD037 Spaces inside emphasis markers
ru/getting-started/friendly-urls/lighttpd.md:11: MD012 Multiple consecutive blank lines
ru/getting-started/friendly-urls/lighttpd.md:24: MD031 Fenced code blocks should be surrounded by blank lines
ru/getting-started/friendly-urls/lighttpd.md:29: MD031 Fenced code blocks should be surrounded by blank lines
ru/getting-started/friendly-urls/lighttpd.md:31: MD031 Fenced code blocks should be surrounded by blank lines
ru/index.md:71: MD005 Inconsistent indentation for list items at the same level
ru/index.md:72: MD005 Inconsistent indentation for list items at the same level
ru/index.md:73: MD005 Inconsistent indentation for list items at the same level
ru/index.md:74: MD005 Inconsistent indentation for list items at the same level
ru/index.md:71: MD006 Consider starting bulleted lists at the beginning of the line
ru/index.md:22: MD022 Headers should be surrounded by blank lines
ru/index.md:26: MD022 Headers should be surrounded by blank lines
ru/index.md:32: MD022 Headers should be surrounded by blank lines
ru/index.md:39: MD022 Headers should be surrounded by blank lines
ru/index.md:43: MD022 Headers should be surrounded by blank lines
ru/index.md:52: MD022 Headers should be surrounded by blank lines
ru/index.md:58: MD022 Headers should be surrounded by blank lines
ru/index.md:62: MD022 Headers should be surrounded by blank lines
ru/index.md:69: MD022 Headers should be surrounded by blank lines
ru/index.md:76: MD022 Headers should be surrounded by blank lines
ru/index.md:80: MD022 Headers should be surrounded by blank lines
ru/index.md:85: MD022 Headers should be surrounded by blank lines
ru/index.md:91: MD022 Headers should be surrounded by blank lines
ru/index.md:43: MD024 Multiple headers with the same content
ru/index.md:52: MD024 Multiple headers with the same content
ru/index.md:62: MD024 Multiple headers with the same content
ru/index.md:69: MD024 Multiple headers with the same content
ru/index.md:80: MD024 Multiple headers with the same content
ru/index.md:85: MD024 Multiple headers with the same content
ru/contribute/documentation/style-guide.md:261: MD001 Header levels should only increment by one level at a time
ru/contribute/documentation/style-guide.md:275: MD005 Inconsistent indentation for list items at the same level
ru/contribute/documentation/style-guide.md:278: MD005 Inconsistent indentation for list items at the same level
ru/contribute/documentation/style-guide.md:275: MD006 Consider starting bulleted lists at the beginning of the line
ru/contribute/documentation/style-guide.md:274: MD012 Multiple consecutive blank lines
ru/contribute/documentation/style-guide.md:277: MD012 Multiple consecutive blank lines
ru/contribute/documentation/style-guide.md:47: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:51: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:63: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:79: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:91: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:107: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:139: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:159: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:177: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:220: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:230: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:245: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:249: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:269: MD019 Multiple spaces after hash on atx style header
ru/contribute/documentation/style-guide.md:278: MD032 Lists should be surrounded by blank lines
ru/contribute/documentation/style-guide.md:55: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:59: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:71: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:75: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:83: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:87: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:95: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:99: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:111: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:115: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:143: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:147: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:163: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:167: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:181: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:185: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:255: MD036 Emphasis used instead of a header
ru/contribute/documentation/style-guide.md:259: MD036 Emphasis used instead of a header
ru/contribute/code/contributors-guide.md:26: MD014 Dollar signs used before commands without showing output
ru/contribute/code/contributors-guide.md:100: MD014 Dollar signs used before commands without showing output
ru/contribute/code/contributors-guide.md:60: MD036 Emphasis used instead of a header
ru/contribute/code/contributors-guide.md:43: MD038 Spaces inside code span elements
ru/contribute/code/coding-standards.md:21: MD031 Fenced code blocks should be surrounded by blank lines
ru/contribute/code/coding-standards.md:29: MD031 Fenced code blocks should be surrounded by blank lines
ru/contribute/code/coding-standards.md:57: MD031 Fenced code blocks should be surrounded by blank lines
ru/contribute/code/coding-standards.md:73: MD031 Fenced code blocks should be surrounded by blank lines
ru/contribute/code/git-github/frequent-commands.md:23: MD014 Dollar signs used before commands without showing output
ru/contribute/code/git-github/frequent-commands.md:33: MD014 Dollar signs used before commands without showing output
ru/contribute/code/git-github/frequent-commands.md:41: MD014 Dollar signs used before commands without showing output
ru/contribute/code/git-github/frequent-commands.md:49: MD014 Dollar signs used before commands without showing output
ru/contribute/code/git-github/index.md:28: MD031 Fenced code blocks should be surrounded by blank lines
ru/contribute/code/git-github/index.md:19: MD036 Emphasis used instead of a header
ru/contribute/code/git-github/index.md:25: MD036 Emphasis used instead of a header
ru/contribute/code/git-github/index.md:42: MD036 Emphasis used instead of a header
ru/contribute/code/index.md:10: MD034 Bare URL used
ru/contribute/code/index.md:41: MD034 Bare URL used
ru/_legacy/getting-started/modx-and-suhosin.md:31: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:32: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:33: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:34: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:35: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:36: MD005 Inconsistent indentation for list items at the same level
ru/_legacy/getting-started/modx-and-suhosin.md:40: MD005 Inconsistent indentation for list items at the same level

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Docs "Upgrading MODX" missing for minor versions 2.5 / 2.6 / 2.7

Affected page(s)

https://github.com/Mark-H/Docs/tree/2.x/en/getting-started/maintenance/upgrading

What needs to be improved?

Documents for "Upgrading MODX" per minor version are missing.

Upgrading to 2.5
Upgrading to 2.6
Upgrading to 2.7

[highlights and things to consider when upgrading to this release; one page per minor version]

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Move to do's from Google Doc into this repository

In https://docs.google.com/document/d/1gdg4daB5-oRIN0o6Sy96S8qbq2-Ew8pZtAfZHke7Vr4/edit I added a lot of comments to different pages as I went through it all.

Some of those were about missing pages, some were about things that didn't seem right.

Those comments should be extracted from the doc and turned into separate issues in this repository so people can help with them.

Add MODX.com to table on extras/index.md

Affected page(s)

https://docs.modx.org/current/en/extras

What needs to be improved?

The table lists sources, but to anyone just skimming the page they wont notice MODX.com being listed as official source before the table.

So MODX.com should be added as first row in the table.

Relevant context

All.

Conversion to-do's

These to do's were automatically generated from some very simple checks in the conversion process.

I have a bunch of images locally (which I uploaded to the server with the first deployment), but those should become part of the repository. I'm thinking an images directory in each language directory, so they can be localised as needed.

Ideally the images should not named in the current random-file-hash way, but actually useful so the context is enough to be able of going through and updating them... which would require some content modifications.

Including extras - yay or nay?

There's been some discussion in #documentation about whether or not extras should be included in the new docs.

Arguments in favour:

Keeps it all in one place, so easier to find for users

Arguments against:

Will conflict with release-based documentation (MODX 2 vs 3), as versioning for extras does not match that of the core.
Hosting extras along the core may give the impression that they are official extras. There's additional noise from extras in the repo which is not relevant to people working on core docs. Giving developers permission to commit/approve changes to docs for their own extras would mean giving them permission to commit changes to all of the documentation.

Other ideas include allowing third party devs to manage docs within their own repos and pulling those in, or having a second docs repo just for extras.

Remove manual table of contents

Affected page(s)

A lot of pages.

What needs to be improved?

Previously, table of contents were manually added into the content. We're now automatically generating them from headers, leading to duplicated table of contents. In many cases the manual table of contents is also marked as a broken link, but that might be more of a bug in the app.

All manual table of contents should be removed from all pages.

For example: https://docs.modx.org/current/en/getting-started/installation/advanced

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Expanding extending-modx/development-environment

Affected page(s)

https://docs.modx.org/current/en/extending-modx/development-environment

What needs to be improved?

This documentation needs to be (re)written as the previous version was not useful. The Building an Extra in MODX Revolution is a good start, explaining the different concepts in tutorial form.

Markdown code style issues in /en/community

Using markdownlint, the following markdown issues are flagged in the Community section:

(Note: I think the coding standards/style guide need a full rewrite, so might not be worth updating these particular code style things.)

en/community/contribute/becoming-a-contributor/modx-php-coding-standards.md:17: MD012 Multiple consecutive blank lines
en/community/contribute/becoming-a-contributor/modx-php-coding-standards.md:18: MD012 Multiple consecutive blank lines
en/community/contribute/becoming-a-contributor/modx-php-coding-standards.md:41: MD031 Fenced code blocks should be surrounded by blank lines
en/community/contribute/becoming-a-contributor/modx-php-coding-standards.md:75: MD031 Fenced code blocks should be surrounded by blank lines
en/community/contribute/using-git-and-github/index.md:19: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:27: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:28: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:44: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:45: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:49: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:50: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/index.md:32: MD031 Fenced code blocks should be surrounded by blank lines
en/community/contribute/using-git-and-github/index.md:38: MD031 Fenced code blocks should be surrounded by blank lines
en/community/contribute/using-git-and-github/index.md:40: MD031 Fenced code blocks should be surrounded by blank lines
en/community/contribute/using-git-and-github/git-fac-(frequently-accessed-commands).md:14: MD012 Multiple consecutive blank lines
en/community/contribute/using-git-and-github/git-fac-(frequently-accessed-commands).md:15: MD012 Multiple consecutive blank lines
en/community/contribute/becoming-a-contributor.md:14: MD012 Multiple consecutive blank lines
en/community/contribute/becoming-a-contributor.md:15: MD012 Multiple consecutive blank lines
en/community/style-guide.md:262: MD001 Header levels should only increment by one level at a time
en/community/style-guide.md:276: MD005 Inconsistent indentation for list items at the same level
en/community/style-guide.md:279: MD005 Inconsistent indentation for list items at the same level
en/community/style-guide.md:276: MD006 Consider starting bulleted lists at the beginning of the line
en/community/style-guide.md:275: MD012 Multiple consecutive blank lines
en/community/style-guide.md:278: MD012 Multiple consecutive blank lines
en/community/style-guide.md:48: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:52: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:64: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:80: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:92: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:108: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:140: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:160: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:178: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:221: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:231: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:246: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:250: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:270: MD019 Multiple spaces after hash on atx style header
en/community/style-guide.md:279: MD032 Lists should be surrounded by blank lines
en/community/style-guide.md:56: MD036 Emphasis used instead of a header
en/community/style-guide.md:60: MD036 Emphasis used instead of a header
en/community/style-guide.md:72: MD036 Emphasis used instead of a header
en/community/style-guide.md:76: MD036 Emphasis used instead of a header
en/community/style-guide.md:84: MD036 Emphasis used instead of a header
en/community/style-guide.md:88: MD036 Emphasis used instead of a header
en/community/style-guide.md:96: MD036 Emphasis used instead of a header
en/community/style-guide.md:100: MD036 Emphasis used instead of a header
en/community/style-guide.md:112: MD036 Emphasis used instead of a header
en/community/style-guide.md:116: MD036 Emphasis used instead of a header
en/community/style-guide.md:144: MD036 Emphasis used instead of a header
en/community/style-guide.md:148: MD036 Emphasis used instead of a header
en/community/style-guide.md:164: MD036 Emphasis used instead of a header
en/community/style-guide.md:168: MD036 Emphasis used instead of a header
en/community/style-guide.md:182: MD036 Emphasis used instead of a header
en/community/style-guide.md:186: MD036 Emphasis used instead of a header
en/community/style-guide.md:256: MD036 Emphasis used instead of a header
en/community/style-guide.md:260: MD036 Emphasis used instead of a header

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Tables get flattened to paragraph

Affected page(s)

What needs to be improved?

The tags are supposed to be shown in a table, but it appears to have been flattened to a single paragraph. It looks like this needs to be corrected in the conversion step.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Issue on getting-started/server-requirements

Affected page(s)

https://docs.modx.org/current/en/getting-started/server-requirements

What needs to be improved?

This section should be rewritten because the data is outdated and the actual data is needed.

Information can be obtained from the official site https://modx.com/download

Markdown code style issues in /en/contribute

Using markdownlint, the following markdown issues are flagged in the Contribute section:

en/contribute/documentation/style-guide.md:276: MD005 Inconsistent indentation for list items at the same level
en/contribute/documentation/style-guide.md:279: MD005 Inconsistent indentation for list items at the same level
en/contribute/documentation/style-guide.md:276: MD006 Consider starting bulleted lists at the beginning of the line
en/contribute/documentation/style-guide.md:275: MD012 Multiple consecutive blank lines
en/contribute/documentation/style-guide.md:278: MD012 Multiple consecutive blank lines
en/contribute/documentation/style-guide.md:48: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:52: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:64: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:80: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:92: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:108: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:140: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:160: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:178: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:221: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:231: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:246: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:250: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:270: MD019 Multiple spaces after hash on atx style header
en/contribute/documentation/style-guide.md:279: MD032 Lists should be surrounded by blank lines
en/contribute/documentation/style-guide.md:56: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:60: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:72: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:76: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:84: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:88: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:96: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:100: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:112: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:116: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:144: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:148: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:164: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:168: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:182: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:186: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:256: MD036 Emphasis used instead of a header
en/contribute/documentation/style-guide.md:260: MD036 Emphasis used instead of a header
en/contribute/code/contributors-guide.md:27: MD014 Dollar signs used before commands without showing output
en/contribute/code/contributors-guide.md:100: MD014 Dollar signs used before commands without showing output
en/contribute/code/coding-standards.md:22: MD031 Fenced code blocks should be surrounded by blank lines
en/contribute/code/coding-standards.md:29: MD031 Fenced code blocks should be surrounded by blank lines
en/contribute/code/coding-standards.md:37: MD031 Fenced code blocks should be surrounded by blank lines
en/contribute/code/coding-standards.md:56: MD031 Fenced code blocks should be surrounded by blank lines
en/contribute/code/coding-standards.md:71: MD031 Fenced code blocks should be surrounded by blank lines
en/contribute/code/coding-standards.md:21: MD032 Lists should be surrounded by blank lines
en/contribute/code/coding-standards.md:30: MD032 Lists should be surrounded by blank lines
en/contribute/code/coding-standards.md:36: MD032 Lists should be surrounded by blank lines
en/contribute/code/coding-standards.md:55: MD032 Lists should be surrounded by blank lines
en/contribute/code/git-github/frequent-commands.md:24: MD014 Dollar signs used before commands without showing output
en/contribute/code/git-github/frequent-commands.md:34: MD014 Dollar signs used before commands without showing output
en/contribute/code/git-github/frequent-commands.md:42: MD014 Dollar signs used before commands without showing output
en/contribute/code/git-github/frequent-commands.md:50: MD014 Dollar signs used before commands without showing output
en/contribute/code/git-github/index.md:19: MD012 Multiple consecutive blank lines
en/contribute/code/git-github/index.md:27: MD012 Multiple consecutive blank lines
en/contribute/code/git-github/index.md:28: MD012 Multiple consecutive blank lines
en/contribute/code/git-github/index.md:45: MD012 Multiple consecutive blank lines
en/contribute/code/git-github/index.md:31: MD031 Fenced code blocks should be surrounded by blank lines

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Create CONTRIBUTING.md

Request for new documentation

You need to create a guide to tell how people should contribute to your project.
https://help.github.com/en/articles/setting-guidelines-for-repository-contributors

With an indication of the rules of design, structure, and so on.
https://github.com/modxorg/Docs/community

Problem with making-sites-with-modx/customizing-content/input-and-output-filters-(output-modifiers).md

Affected page(s)

current/en/making-sites-with-modx/customizing-content/input-and-output-filters-(output-modifiers)

making-sites-with-modx/customizing-content/input-and-output-filters-(output-modifiers).md

What needs to be improved?

The last part of the page seems to be invalid markdown, with some weird code mixing.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

ArchivistGrouper documentation very insecure

Affected page(s)

en/extras/archivist/archivist.archivistgrouper.md

What needs to be improved?

The Articles addon 1.6.1 came with the Archivist addon 1.2.3, so I suppose this ArchivistGrouper snippet is now part of Archivist. No documentation yet from its creator, but I found the available properties in the snippet.

The descriptions in the table are just a guess!!! Someone with more experience or the creator should confirm or adjust these!!

The content should be checked, and updated.

Incorrect translation references in /ru/

Original path "/2.x/en/ru/extending-modx/services" not found for "2.x/ru/extending-modx/services/index.md"
Original path "/2.x/en/extending-modx/creating-components/extjs-widgets" not found for "2.x/ru/extending-modx/creating-components/extjs-widgets/index.md"
Original path "/2.x/en/extending-modx/creating-components/subscription-edit-window" not found for "2.x/ru/extending-modx/creating-components/subscription-edit-window/index.md"
Original path "/2.x/en/extending-modx/creating-components/snippet-sendex" not found for "2.x/ru/extending-modx/creating-components/snippet-sendex/index.md"
Original path "/2.x/en/extending-modx/creating-components/letter-queue-table" not found for "2.x/ru/extending-modx/creating-components/letter-queue-table/index.md"
Original path "/2.x/en/extending-modx/creating-components/subscription-table" not found for "2.x/ru/extending-modx/creating-components/subscription-table/index.md"
Original path "/2.x/en/building-sites/client-proofing/security/security" not found for "2.x/ru/building-sites/client-proofing/security/index.md"
Original path "/2.x/en/building-sites/resources/content-type" not found for "2.x/ru/building-sites/resources/content-types.md"

@Ibochkarev Could you fix these? Translation references in the heading bit should only contain the part after the version/language, like /building-sites/resources/content-type

Would also be good if you can pay attention to that when people submit Russian translations, to avoid it from happening ;)

Remove Evolution notifications

Affected page(s)

Where are the references to Evolution

What needs to be improved?

Remove all references to Evolution from the documentation sections, since this version of CMS is no longer supported in the distant past.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Expanding on extending-modx/developing-restful-api

Affected page(s)

https://docs.modx.org/current/en/extending-modx/developing-restful-api

What needs to be improved?

This page should be expanded.

Relevant context

The problem affects the following version(s):

2.x (current)
3.x

Keep the translated documentation manageable

Affected page(s)

All translated documentation pages.

What needs to be improved?

Directories and files for translated documentation should mirror the English content. This makes it easier to manage:

Only the language key has to be changed which makes switching languages easier.
It's easier to find pages that are not yet translated.
etc.

Don't see any video from Vimeo

Affected page(s)

https://modxdocs.mhserver.nl/current/en/getting-started/video-quick-start-series

What needs to be improved?

Connect the player to play the video on the page

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Documentation for MODX 3 Alpha

This issue will contain a work-in-progress list of changes in 3.0 that should be documented.

It's probably not complete... please do pop in and help. To edit a page in the docs, find the "Edit this page link" under the title on docs.modx.org or browse the repo and click Edit on the relevant source file.

Make sure you're targetting the 3.x branch!

New features

Changes to manager language selection, including on the fly selection
Passwordless login modxcms/revolution#14351
Content-type based icons for in the tree - is the template based icon documented? modxcms/revolution#14383
New output filters related to file handling modxcms/revolution#14198
custom backgrounds on the login screen, plus ability to use extras for it like https://github.com/Mark-H/Login_Unsplash (unreleased proof of concept)
Dashboard widgets configurable on the dashboard itself modxcms/revolution#13844
New options on grid (extjs) to control the automatically added gear icon modxcms/revolution#14806

xPDO 3

... bunch of stuff goes here ...

PSR-4 autoloading w/ composer
xPDO 3 model refactor

Changed features

These may or may not have existing documentation but should probably be noted somewhere.

Changes to password reset handling, such as no passwords in the email modxcms/revolution#13786
Package attributes now being parsed as markdown modxcms/revolution#13853
Core directory protected in media sources modxcms/revolution#14374
Something about this parser change for better array support in custom parsers modxcms/revolution#14689
MODx.perm is now always loading all permissions automatically modxcms/revolution#14425 modxcms/revolution#13924
modRestService empty string return for empty tags modxcms/revolution#14305
parser change for brackets around tags modxcms/revolution#13904
media sources based on flysystem, AWS v3 support modxcms/revolution#13709 modxcms/revolution#13811

Removed/cleaned up features

This may also need an update in the 2.x branch to note it as being removed in 3.0

@EVAL binding in TVs removed, including allow_tv_eval setting modxcms/revolution#13865
modParser095, modTranslate095, and modTranslator removed modxcms/revolution#14133
modResource->contentType removed (which !== content_type, which still exists) modxcms/revolution#14057
xmlrss modxcms/revolution#14034
xmlrpc/jsonrpc classes modxcms/revolution#14033
flash based copy to clipboard modxcms/revolution#13814

Other breaking changes

Which should probably only be mentioned in the breaking changes section.

/manager/min/ directory removed modxcms/revolution#12778 modxcms/revolution#13194 modxcms/revolution#14416
Renamed processor class names and locations
- Special attention to resource-related processors, because of custom resource types that may call/require those directly
Renamed model classes, which are auto converted in loadClass which doesn't help with things like instanceof checks
Renamed/moved classes that get a BC assist from the autoloader until 3.3 modxcms/revolution#14704

Setting changes

automatic_template_assignment default changed to sibling modxcms/revolution#14328
preserve_menuindex default changed to false modxcms/revolution#14328
manager_favicon_url new default icon modxcms/revolution#14324
manager_time_format default changed modxcms/revolution#14325

Removed settings

May have docs that need to be removed/updated, as well as changes in the 2.x branch to indicate changes are coming.

allow_tv_eval modxcms/revolution#13865
compress_js_max_files modxcms/revolution#13859
manager_js_zlib_output_compression modxcms/revolution#13859
upload_flash modxcms/revolution#14252
manager_language
udperms_allowroot, webpwdreminder_message modxcms/revolution#14841
manager_js_cache_file_locking, manager_js_cache_max_age, manager_js_document_root modxcms/revolution#14868
resolve_hostnames, server_protocol modxcms/revolution#14877

Manager interface/design changes

Perhaps a "notable ui changes" document? IMO not as important in alpha phase as the UI is probably going to evolve further

Others

Upgrades to 3.0 are only supported for 2.6+ modxcms/revolution@9a527c6#diff-948b50215f9ff1174344c1b416fd0ac5 modxcms/revolution#14878

Uses of @EVAL in tutorials that need to be updated now that eval is gone:

administering-your-site/using-friendly-urls.md suggests to cache the base tag, which is bad advice

Affected page(s)

http://modxdocs.mhserver.nl/current/en/administering-your-site/using-friendly-urls#3-edit-your-template-s

What needs to be improved?

Edit your template(s)
Make sure you have the following tag in the head section of all your templates. If you have only one front-end context (e.g., 'web') you can usually leave out the exclamation point to speed of page loads:

<base href="[[!++site_url]]" />

Caching that call opens the way for cache poisoning on certain environments. The speed benefit is neglible, so that should always be cached.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Incorrect table formatting on extras/renderresources/index.md

Affected page(s)

http://docs.modx.org/current/en/extras/renderresources

What needs to be improved?

Under "Selection Properties" at the start and end of that section, there are some broken tables.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Expanding Internationalization / Multilanguage Sites

Affected page(s)

Pages about i18n / multilanguage sites
https://github.com/Mark-H/Docs/blob/2.x/en/building-sites/i18n/index.md

What needs to be improved?

Existing stub has to be expanded.

Lexicons
Multiple Contexts and routing
Relevant Extras (Babel, MIGXMultilLang, Lingua, Localizator ...)

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Login extra -various pages not found

Page not found

Link source

https://docs.modx.org/current/en/extras/login/login

Issue on extras/collections

Affected page(s)

https://docs.modx.org/current/en/extras/collections

What needs to be improved?

The specified image in the document is not displayed.

Expanding extending-modx/processors

Affected page(s)

https://docs.modx.org/current/en/extending-modx/processors

What needs to be improved?

This documentation needs to be (re)written as the previous version was not useful.

Markdown code style issues in /en/extending-modx

Using markdownlint, the following markdown issues are flagged in the Extending MODX section:

en/extending-modx/snippets/accessing-tvs.md:69: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:70: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:71: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:72: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:73: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:74: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:77: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:78: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:79: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:80: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/accessing-tvs.md:81: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/snippets/good-snippet.md:62: MD001 Header levels should only increment by one level at a time
en/extending-modx/snippets/good-snippet.md:9: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:48: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:52: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:56: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:62: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:76: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:84: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:107: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:113: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:127: MD019 Multiple spaces after hash on atx style header
en/extending-modx/snippets/good-snippet.md:9: MD022 Headers should be surrounded by blank lines
en/extending-modx/snippets/good-snippet.md:62: MD022 Headers should be surrounded by blank lines
en/extending-modx/snippets/good-snippet.md:65: MD022 Headers should be surrounded by blank lines
en/extending-modx/snippets/good-snippet.md:72: MD022 Headers should be surrounded by blank lines
en/extending-modx/plugins/system-events/onbeforemanagerlogin.md:29: MD032 Lists should be surrounded by blank lines
en/extending-modx/plugins/system-events/onbeforeweblogin.md:29: MD032 Lists should be surrounded by blank lines
en/extending-modx/plugins/system-events/onwebpageprerender.md:33: MD012 Multiple consecutive blank lines
en/extending-modx/plugins/system-events/onwebpageprerender.md:34: MD012 Multiple consecutive blank lines
en/extending-modx/plugins/system-events/onmanagerlogin.md:20: MD032 Lists should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdoobject/related-object-accessors/addone.md:46: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdoobject/static-object-loaders/using-custom-loader-classes.md:21: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdoquery/xpdoquery.where.md:7: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdoquery/xpdoquery.where.md:29: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdoquery/xpdoquery.where.md:40: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdoquery/xpdoquery.where.md:129: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdoquery/xpdoquery.where.md:155: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.getcount.md:13: MD036 Emphasis used instead of a header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:7: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:14: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:26: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:28: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:38: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:40: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:86: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:97: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:122: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:145: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:158: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:165: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:38: MD024 Multiple headers with the same content
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:40: MD024 Multiple headers with the same content
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:114: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:22: MD036 Emphasis used instead of a header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.query.md:34: MD036 Emphasis used instead of a header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:7: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:11: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:30: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:36: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:38: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:52: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:64: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:77: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:108: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:116: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:127: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.log.md:137: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/class-reference/xpdo/xpdo.loadclass.md:31: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/class-reference/xpdo/xpdo.loadclass.md:32: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/class-reference/xpdo/xpdo.loadclass.md:28: MD032 Lists should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdoquery.md:77: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/class-reference/xpdoquery.md:78: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/class-reference/xpdoquery.md:31: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/class-reference/xpdoobject.md:10: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:11: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:12: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:13: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:14: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:15: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:16: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:18: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:19: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:21: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:22: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:23: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:24: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:25: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:26: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:28: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:29: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:30: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:31: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:33: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:34: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:36: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:37: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:38: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:39: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:40: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:41: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:43: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:44: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:45: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:46: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:47: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:49: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:50: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/class-reference/xpdoobject.md:51: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/custom-models/generating-the-model/reverse-engineer.md:273: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/custom-models/generating-the-model/reverse-engineer.md:274: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/custom-models/defining-a-schema/relationships.md:9: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/custom-models/defining-a-schema/relationships.md:39: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/custom-models/defining-a-schema/relationships.md:73: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/custom-models/defining-a-schema/relationships.md:179: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/custom-models/defining-a-schema/relationships.md:185: MD019 Multiple spaces after hash on atx style header
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:110: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:126: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:148: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:173: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:195: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:228: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:253: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:265: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:283: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:306: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/more-examples.md:331: MD024 Multiple headers with the same content
en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1.md:42: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1.md:43: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1.md:38: MD032 Lists should be surrounded by blank lines
en/extending-modx/xpdo/custom-models/defining-a-schema/index.md:15: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/custom-models/defining-a-schema/database-and-tables.md:95: MD036 Emphasis used instead of a header
en/extending-modx/xpdo/custom-models/defining-a-schema/validators.md:31: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/setting-object-fields.md:100: MD022 Headers should be surrounded by blank lines
en/extending-modx/xpdo/setting-object-fields.md:101: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/removing-objects.md:23: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/custom-object-loaders.md:26: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/retrieving-objects/graphs.md:163: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:164: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:165: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:166: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:167: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:168: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:169: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:170: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:171: MD005 Inconsistent indentation for list items at the same level
en/extending-modx/xpdo/retrieving-objects/graphs.md:97: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/retrieving-objects/graphs.md:82: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/create-xpdo-instance/index.md:12: MD031 Fenced code blocks should be surrounded by blank lines
en/extending-modx/xpdo/creating-objects.md:39: MD012 Multiple consecutive blank lines
en/extending-modx/xpdo/creating-objects.md:40: MD036 Emphasis used instead of a header
en/extending-modx/modx-class/reference/modx.sendforward.md:7: MD036 Emphasis used instead of a header
en/extending-modx/modx-class/loading-externally.md:7: MD019 Multiple spaces after hash on atx style header
en/extending-modx/modx-class/loading-externally.md:23: MD019 Multiple spaces after hash on atx style header
en/extending-modx/modx-class/loading-externally.md:39: MD019 Multiple spaces after hash on atx style header
en/extending-modx/modx-class/loading-externally.md:52: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/step-2-overriding-methods.md:14: MD012 Multiple consecutive blank lines
en/extending-modx/custom-resources/index.md:18: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:33: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:55: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:79: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:98: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:114: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:128: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:159: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:180: MD019 Multiple spaces after hash on atx style header
en/extending-modx/custom-resources/index.md:240: MD019 Multiple spaces after hash on atx style header
en/extending-modx/developing-restful-api.md:56: MD001 Header levels should only increment by one level at a time
en/extending-modx/developing-restful-api.md:150: MD038 Spaces inside code span elements

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Broken URLs after major reorder

For the following pages, the new URL to redirect to could not be identified.

Most of these cases are the result of either the page being removed because it was useless (e.g. if it had been under construction since 2011), or in some cases generic index pages were removed as well because it's been restructured. There are typically pages these should go to, but that could not be identified automatically. Some are also expected to simply 404.

{
    "/revolution/2.x/administering-your-site": true,
    "/revolution/2.x/administering-your-site/upgrading-modx/upgrading-to-revolution-2.0.5": true,
    "/revolution/2.x/administering-your-site/form-customization": true,
    "/revolution/2.x/administering-your-site/form-customization/form-customization-pages": true,
    "/revolution/2.x/administering-your-site/form-customization/form-customization-pages/fc-chunk": true,
    "/revolution/2.x/administering-your-site/form-customization/form-customization-pages/fc-plugin": true,
    "/revolution/2.x/administering-your-site/form-customization/form-customization-pages/fc-snippet": true,
    "/revolution/2.x/administering-your-site/form-customization/form-customization-pages/fc-template": true,
    "/revolution/2.x/administering-your-site/security/security-standards": true,
    "/revolution/2.x/case-studies-and-tutorials/quick-and-easy-modx-tutorials": true,
    "/revolution/2.x/developing-in-modx/advanced-development/": true,
    "/revolution/2.x/developing-in-modx/advanced-development/package-management/": true,
    "/revolution/2.x/developing-in-modx/basic-development/": true,
    "/revolution/2.x/developing-in-modx/other-development-resources": true,
    "/revolution/2.x/developing-in-modx/overview-of-modx-development": true,
    "/revolution/2.x/making-sites-with-modx/customizing-content": true,
    "/revolution/2.x/making-sites-with-modx/structuring-your-site": true,
    "/revolution/2.x/modx-community-information": true,
    "/revolution/2.x/modx-community-information/becoming-a-core-contributor": true,
    "/revolution/2.x/modx-community-information/filing-bug-reports": true,
    "/revolution/2.x/modx-community-information/getting-a-modx-account": true,
    "/revolution/2.x/modx-community-information/using-github": true,
    "/community/": true,
    "/xpdo/2.x/advanced-features": true,
    "/xpdo/2.x/class-reference": true,
    "/xpdo/2.x/extending-your-xpdo-model": true,
    "/xpdo/2.x/extending-your-xpdo-model/overriding-derived-behavior": true,
    "/xpdo/2.x/extending-your-xpdo-model/working-with-transient-object-classes": true,
    "/xpdo/2.x/getting-started/creating-a-model-with-xpdo": true,
    "/xpdo/2.x/getting-started/creating-a-model-with-xpdo/generating-the-model-code/domain-classes": true,
    "/xpdo/2.x/getting-started/creating-a-model-with-xpdo/generating-the-model-code/o-r-maps": true,
    "/xpdo/2.x/getting-started/creating-a-model-with-xpdo/generating-the-model-code/table-classes": true,
    "/xpdo/2.x/getting-started/fundamentals": true,
    "/xpdo/2.x/getting-started/fundamentals/design-patterns": true,
    "/xpdo/2.x/getting-started/fundamentals/xpdo,-the-class": true,
    "/xpdo/2.x/getting-started/fundamentals/xpdo,-the-class/as-object-and-relational-mapper": true,
    "/xpdo/2.x/getting-started/fundamentals/xpdo,-the-class/as-pdo-wrapper": true,
    "/xpdo/2.x/getting-started/fundamentals/xpdo,-the-class/as-service-layer": true,
    "/xpdo/2.x/getting-started/introduction-to-the-xpdo-object-model": true,
    "/xpdo/2.x/getting-started/using-your-xpdo-model": true,
    "/xpdo/2.x/getting-started/using-your-xpdo-model/removing-objects/removecollection": true,
    "/xpdo/2.x/overview": true,
    "/xpdo/2.x/overview/known-issues": true,
    "/xpdo/2.x/overview/what-it-is": true,
    "/xpdo/2.x/xpdo-development": true,
    "/xpdo/2.x/xpdo-development/building": true,
    "/xpdo/2.x/xpdo-development/testing": true,
    "/xpdo/": true,
    "/revolution/page-not-found": true,
    "/community/page-not-found": true,
    "/xpdo/page-not-found": true
}

Any URLs that should be redirected should go into the redirects.json for 2.x.

Markdown validation issues

I've added a new github action but that's showing another 200 or so validation issues across 2.x that need to be resolved, before it's useful as an automatic check.

I've already fixed a bunch, but could use some help :p

No documentation for xrouting and LangRouter

Affected page(s)

https://docs.modx.org/current/en/extras

What needs to be improved?

No documentation for xrouting and LangRouter. Although everything is on the old domain.

https://modx.com/extras/package/xrouting
https://modx.com/extras/package/LangRouter

Relevant context

Is the problem only in a specific version or language? Then please include that.

Anchor Links Broken

Affected page(s)

http://136.144.181.182/~modxdocs/current/en/getting-started/installation/command-line-installation/the-setup-config-xml-file

and many more pages with anchor links.

What needs to be improved?

Anchor links inside "On this page" are broken (goes to root of site).

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Add the ability to register documentation changes (Changelog)

What needs to be improved?

It is necessary to add the ability to register changes in the documentation. Keep a list of changes - since the documentation will be updated, new sections are added, some of the content is deleted for various reasons. It is important that the original source (English version) - recorded changes.

Suggestions:

Changelog - after pouring into the repository
Mark visually in the documentation using a special tag:

[! NOTE]
This is a NOTE

[! WARNING]
This is a WARNING

[! TIP]
This is a TIP

[! IMPORTANT]
This is IMPORTANT

This will allow:

see what is not translated, updated
maintain the relevance of the documentation based on the experience and knowledge of colleagues

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

test

Affected page(s)

Please provide a link to the page(s) that have an issue, or even better, the link to the source file in the repository. For long pages, please include approximately where the problem is (heading or line numbers)

What needs to be improved?

Be as specific as possible; is there a typo, incorrect capitalisation of MODX, or does an entire section need work? What is unclear or incorrect? If an inaccuracy or unclear description was discussed on the forums or slack, include a link to that discussion.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Markup in htaccess block on Hardening MODX Revolution

Affected page(s)

en/administering-your-site/security/hardening-modx-revolution, section Forcing SSL connections to the Manager

What needs to be improved?

In the section Forcing SSL connections to the Manager, there is some markup (a <a> tag) mixed with the htaccess example code.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Issue on getting-started/installation/standard

Affected page(s)

https://docs.modx.org/current/en/getting-started/installation/standard

What needs to be improved?

The last link to youtube in the See Also block is broken.
When you go on it - youtube reports that the video is not available

http://www.youtube.com/watch?v=Wwrq-3CWFVU

Automatically convert links to point to right URLs

Both due to the major reshuffling of content and simply the conversion from the old site, there are tons of incorrect links in the content.

Most of those still work - because of the redirects that are in place.

But ideally, a mass automated link update should be executed that fetches the markdown files to look at URLs in the content, see if there's a known redirect (or perhaps other transformation) that should be applied to it, and writes the file with the correct URL.

One example for that is the links under "See also" at http://modxdocs.mhserver.nl/current/en/building-sites/client-proofing/dashboards/usergroups - those links point to an incorrect URL, and redirect to the right one.

While this process runs, it could also create a list of potentially broken links that should be manually checked. I'd expect a broken link to be a link that is not external (starts with http(s)://), or anchors, and also do not exist in the doc_sources dir as markdown.

Markdown code style issues in /en/building-sites

Using markdownlint, the following markdown issues are flagged in the Building Sites section:

en/building-sites/settings/emailsender.md:7: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/emailsender.md:17: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:19: MD012 Multiple consecutive blank lines
en/building-sites/settings/index.md:20: MD012 Multiple consecutive blank lines
en/building-sites/settings/index.md:34: MD012 Multiple consecutive blank lines
en/building-sites/settings/index.md:41: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:51: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:69: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:73: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:85: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:127: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:149: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:175: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:212: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:229: MD019 Multiple spaces after hash on atx style header
en/building-sites/settings/index.md:23: MD022 Headers should be surrounded by blank lines
en/building-sites/settings/index.md:35: MD023 Headers must start at the beginning of the line
en/building-sites/settings/upload_files.md:7: MD019 Multiple spaces after hash on atx style header
en/building-sites/contexts/virtual-host.md:71: MD001 Header levels should only increment by one level at a time
en/building-sites/resources/symlink/using-resource-symlinks.md:11: MD001 Header levels should only increment by one level at a time
en/building-sites/resources/index.md:158: MD005 Inconsistent indentation for list items at the same level
en/building-sites/resources/static-resource.md:26: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/profiles.md:18: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/sets.md:54: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/tabs.md:43: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/tabs.md:12: MD012 Multiple consecutive blank lines
en/building-sites/client-proofing/form-customization/index.md:28: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/index.md:40: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/form-customization/index.md:11: MD023 Headers must start at the beginning of the line
en/building-sites/client-proofing/form-customization/rules/field-default.md:19: MD022 Headers should be surrounded by blank lines
en/building-sites/client-proofing/form-customization/rules/field-default.md:20: MD031 Fenced code blocks should be surrounded by blank lines
en/building-sites/client-proofing/form-customization/rules/new-tab.md:36: MD012 Multiple consecutive blank lines
en/building-sites/client-proofing/form-customization/rules/new-tab.md:37: MD012 Multiple consecutive blank lines
en/building-sites/client-proofing/form-customization/rules/field-label.md:17: MD022 Headers should be surrounded by blank lines
en/building-sites/client-proofing/form-customization/rules/field-label.md:18: MD031 Fenced code blocks should be surrounded by blank lines
en/building-sites/client-proofing/form-customization/rules/move-tv-to-tab.md:22: MD012 Multiple consecutive blank lines
en/building-sites/client-proofing/form-customization/rules/move-tv-to-tab.md:23: MD012 Multiple consecutive blank lines
en/building-sites/client-proofing/security/user-groups.md:75: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:78: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:79: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:81: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:82: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:83: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:84: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:85: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:89: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/user-groups.md:7: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:11: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:24: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:33: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:41: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:53: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/user-groups.md:68: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/security-tutorials/giving-a-user-manager-access.md:18: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/security-tutorials/giving-a-user-manager-access.md:19: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/security-tutorials/making-member-only-pages.md:79: MD024 Multiple headers with the same content
en/building-sites/client-proofing/security/security-tutorials/creating-a-second-super-admin-user.md:18: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/security-tutorials/creating-a-second-super-admin-user.md:19: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:54: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:57: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:58: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:60: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:61: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:62: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:63: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:64: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/acls.md:68: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:33: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:36: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:37: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:39: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:40: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:41: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:42: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:43: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/permissions/index.md:47: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:79: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:82: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:83: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:85: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:86: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:87: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:88: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:89: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:93: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/index.md:28: MD036 Emphasis used instead of a header
en/building-sites/client-proofing/security/policies/policytemplates.md:44: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:47: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:48: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:50: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:51: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:52: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:53: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:54: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/policies/policytemplates.md:58: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:53: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:56: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:57: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:59: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:60: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:61: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:62: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:63: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/roles.md:67: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:121: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:124: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:125: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:127: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:128: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:129: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:130: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:131: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:135: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/users.md:7: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:13: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:23: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:39: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:82: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:99: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/users.md:114: MD019 Multiple spaces after hash on atx style header
en/building-sites/client-proofing/security/resource-groups.md:36: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:39: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:40: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:42: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:43: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:44: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:45: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:46: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/security/resource-groups.md:50: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/custom-manager-themes.md:19: MD036 Emphasis used instead of a header
en/building-sites/client-proofing/custom-manager-themes.md:23: MD036 Emphasis used instead of a header
en/building-sites/client-proofing/custom-manager-themes.md:29: MD036 Emphasis used instead of a header
en/building-sites/client-proofing/custom-manager-themes.md:33: MD036 Emphasis used instead of a header
en/building-sites/client-proofing/dashboards/usergroups.md:21: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/usergroups.md:22: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/usergroups.md:23: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/usergroups.md:24: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/managing.md:23: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/managing.md:24: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/managing.md:25: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/managing.md:26: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/creating-a-widget.md:60: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/creating-a-widget.md:61: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/creating-a-widget.md:62: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/creating-a-widget.md:63: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/index.md:30: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/index.md:31: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/index.md:32: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/index.md:33: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/widget-types/index.md:20: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/widget-types/index.md:21: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/widget-types/index.md:22: MD005 Inconsistent indentation for list items at the same level
en/building-sites/client-proofing/dashboards/widget-types/index.md:23: MD005 Inconsistent indentation for list items at the same level
en/building-sites/contexts.md:31: MD012 Multiple consecutive blank lines
en/building-sites/contexts.md:32: MD012 Multiple consecutive blank lines
en/building-sites/contexts.md:33: MD012 Multiple consecutive blank lines
en/building-sites/contexts.md:34: MD012 Multiple consecutive blank lines
en/building-sites/contexts.md:13: MD019 Multiple spaces after hash on atx style header
en/building-sites/contexts.md:23: MD019 Multiple spaces after hash on atx style header
en/building-sites/contexts.md:57: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/common.md:80: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/common.md:81: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/common.md:9: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/common.md:25: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/common.md:38: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/common.md:82: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/index.md:76: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/index.md:77: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/index.md:106: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/index.md:111: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/index.md:112: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/output-filters/index.md:13: MD012 Multiple consecutive blank lines
en/building-sites/tag-syntax/output-filters/index.md:1: MD038 Spaces inside code span elements
en/building-sites/tag-syntax/output-filters/index.md:1: MD038 Spaces inside code span elements
en/building-sites/tag-syntax/output-filters/index.md:1: MD038 Spaces inside code span elements
en/building-sites/tag-syntax/output-filters/custom.md:7: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/output-filters/custom.md:27: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/output-filters/custom.md:60: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/output-filters/custom.md:66: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/output-filters/custom.md:90: MD019 Multiple spaces after hash on atx style header
en/building-sites/tag-syntax/output-filters/custom.md:176: MD022 Headers should be surrounded by blank lines
en/building-sites/tag-syntax/output-filters/custom.md:120: MD024 Multiple headers with the same content
en/building-sites/tag-syntax/output-filters/custom.md:201: MD031 Fenced code blocks should be surrounded by blank lines
en/building-sites/tag-syntax/output-filters/custom.md:92: MD033 Inline HTML
en/building-sites/media-sources/assigning-to-tvs.md:49: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/assigning-to-tvs.md:51: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/assigning-to-tvs.md:52: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/securing.md:47: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/securing.md:49: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/securing.md:50: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/securing.md:38: MD012 Multiple consecutive blank lines
en/building-sites/media-sources/securing.md:39: MD012 Multiple consecutive blank lines
en/building-sites/media-sources/types.md:17: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/types.md:19: MD005 Inconsistent indentation for list items at the same level
en/building-sites/media-sources/types.md:20: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/templates.md:55: MD033 Inline HTML
en/building-sites/elements/template-variables/index.md:55: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:56: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:57: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:58: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:59: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:60: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:61: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:64: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:65: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:66: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:67: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/index.md:68: MD005 Inconsistent indentation for list items at the same level
en/building-sites/elements/template-variables/input-types/index.md:221: MD024 Multiple headers with the same content
en/building-sites/elements/template-variables/input-types/index.md:273: MD024 Multiple headers with the same content
en/building-sites/elements/template-variables/input-types/index.md:284: MD024 Multiple headers with the same content
en/building-sites/elements/template-variables/input-types/index.md:30: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:48: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:99: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:130: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:146: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:162: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:197: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:237: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:257: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:277: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:302: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:326: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:349: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:367: MD036 Emphasis used instead of a header
en/building-sites/elements/template-variables/input-types/index.md:383: MD036 Emphasis used instead of a header

the-xpdo-constructor markdown

Affected page(s)

http://modxdocs.mhserver.nl/current/en/xpdo/getting-started/fundamentals/xpdo,-the-class/the-xpdo-constructor

What needs to be improved?

Page does not seem to render properly, renders as raw markdown.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Not correct references of this kind [display/revolution20/Input+and+Output+Filters+(Output+Modifiers)]

Affected page(s)

For example: en/building-sites/tag-syntax/date-formats.md

What needs to be improved?

In some documents there are references of this kind:
[display/revolution20/Input+and+Output+Filters+(Output+Modifiers)](display/revolution20/Input+and+Output+Filters+(Output+Modifiers))
[display/revolution20/Commonly+Used+Template+Tags](display/revolution20/Commonly+Used+Template+Tags)

They are not correct and should be corrected.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Issue on /current/en/extras/collections

Bug report

Summary

No images are displayed - instead of pictures - markup markdown

http://docs.modx.org/current/en/extras/collections

The specified image in the document is not displayed.

Integrating Templates: Working with templates, chunks,snippets, etc.

Affected page(s)

https://github.com/Mark-H/Docs/blob/2.x/en/building-sites/integrating-templates/index.md

What needs to be improved?

Topics to be covered:

building templates
chunks,
using snippets
best practices, etc - (mayb) this should be in the form of a guide/tutorial)

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Issue on getting-started/getting-started: guide new users into MODX better

Affected page(s)

http://docs.modx.org/current/en/getting-started/getting-started

What needs to be improved?

According to the documentation, there is no default content in Revo. But there is a default resource and a very basic template now. Those should be explained (where does what come from?) in more detail.

Ideally this page should introduce people to some of the MODX concepts and get them on their way to MODX mastery. It could link generously to other sections like the package manager, the glossary, etc.

Relevant context

All.

getting-started/maintenance missing from menu; needs an index file

Affected page(s)

https://github.com/Mark-H/Docs/tree/2.x/en/getting-started/maintenance

What needs to be improved?

Should be part of the generated menu, which currently requires an index.md in the root of that directory, or a maintenance.md file one dir up.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

Home link broken on page not found: /current/en/_legacy/getting-started/roadmap

Page not found

https://docs.modx.org/current/en/_legacy/getting-started/roadmap

Problem

Tried to find the roadmap, got on a 404, noticed that the home link does not work.

Messed up table for snippet properties on extras/formitfastpack/formitfastpack.field

Affected page(s)

https://docs.modx.org/current/en/extras/formitfastpack/formitfastpack.field

What needs to be improved?

Snippet properties section needs to be rewritten as it had lists in tables and looks seriously messed up now.

Relevant context

English.

Issue on extras/babel

Affected page(s)

https://docs.modx.org/current/en/extras/babel

What needs to be improved?

Imported when moving not the original image, but a preview of a small size. Need to repair or replace images

[![](/download/thumbnails/33587248/babel-setup.PNG)](/download/attachments/33587248/babel-setup.PNG)

All pages Roadmap in Extras contain old information

Affected page(s)

All pages Roadmap in Extras contain old information.
For example:
https://docs.modx.org/current/en/extras/login/login.roadmap
https://docs.modx.org/current/en/extras/quip/quip.roadmap

What needs to be improved?

I think we need to delete these pages. Because relevant information is contained in releases of Extras.

Tag Syntax needs some rewriting and cleaning up

Affected page(s)

https://docs.modx.org/current/en/building-sites/tag-syntax

What needs to be improved?

This document was very clearly written right after Revolution came out, and is very much geared towards helping Evo users get up to speed with Revo.

That should be changed to focus primarily on educating new users of how tags work.

Also:

The paragraph below the big table also doesn't look right; that might have been broken by the conversion and markdown/modx both using backticks for code.
The "Structure of a tag" big is a very useful piece of knowledge to share, but is not properly formatted currently. Needs to be broken up into multiple lines or maybe a code block or something.
The "For example..." paragraph in the Timing section should be removed.

It may also be useful to add some more insights from my blog post about caching guidelines and nested/recursive caching into this document, as there's a lot more that can be said about that than what the current document has to say.

Relevant versions

The problem affects the following version(s):

2.x (current)
3.x

modxorg / docs Goto Github PK

docs's Introduction

MODX Documentation

New documentation goals

Serving up the documentation

Discussion

docs's People

Contributors

Stargazers

Watchers

Forkers

docs's Issues

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Relevant context

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Request for new documentation

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Relevant context

Affected page(s)

What needs to be improved?

Affected page(s)

What needs to be improved?

Relevant versions

New features

xPDO 3

Changed features

Removed/cleaned up features

Other breaking changes

Setting changes

Removed settings

Manager interface/design changes

Others

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Relevant versions

Page not found

Link source

Affected page(s)

What needs to be improved?

Affected page(s)

What needs to be improved?

Affected page(s)

What needs to be improved?

Relevant context

Affected page(s)

What needs to be improved?

Relevant versions

What needs to be improved?

Relevant versions

Affected page(s)

What needs to be improved?

Relevant versions