fix(docs): sort sources by display name in doc's sidebar #7322
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes the order of the sources in the sidebar of the documentation: Previously the sources were automatically sorted by the name of the corresponding markdown file resp. the platform id (the files are named by the platform id). The fix ensures that the corresponding sidebar_position metadata attribute is added to the generated markdown files after the sources were sorted by the platform name (the attribute is needed for the autogenerated sidebar here).
This fixes/reverts #7244 by renaming the SAP HANA source to "SAP HANA" instead of "HANA". I have also seen that the Apache NiFi source was called "Nifi" instead of "NiFi" (see here), therefore I have also quickly renamed it to "NiFi" in this PR.
@RainerGa FYI
edit: I have also renamed the generic SQLAlchemy source to "SQLAlchemy" instead of "Other SQLAlchemy databases", because when sorting the sidebar by the platform name, the source is not sorted after "S" anymore (additionally the long title look ugly in the sidebar):
vs.
Checklist