Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): sort sources by display name in doc's sidebar #7322

Merged

Conversation

Masterchen09
Copy link
Contributor

@Masterchen09 Masterchen09 commented Feb 12, 2023

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):

grafik
vs.
grafik

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added devops PR or Issue related to DataHub backend & deployment docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata labels Feb 12, 2023
@jjoyce0510 jjoyce0510 merged commit da2b0c9 into datahub-project:master Feb 13, 2023
@Masterchen09 Masterchen09 deleted the fix-docs-sources-order branch June 9, 2023 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants