feat(docs): Sort tables #599
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erezrokah
force-pushed
the
feat/sort_tables_in_docs
branch
from
1da842b to
acc19c2
Compare
disq
approved these changes
Jan 11, 2023
erezrokah
force-pushed
the
feat/sort_tables_in_docs
branch
from
acc19c2 to
c005d6e
Compare
⏱️ Benchmark results
|
hermanschaaf
approved these changes
Jan 11, 2023
yevgenypats
approved these changes
Jan 11, 2023
kodiakhq bot
pushed a commit
that referenced
this pull request
Jan 12, 2023
🤖 I have created a release *beep* *boop* --- ## [1.25.0](v1.24.2...v1.25.0) (2023-01-11) ### Features * **docs:** Sort tables ([#599](#599)) ([8a3bfad](8a3bfad)) * **transformers:** Add support for `net.IP` ([#595](#595)) ([a420645](a420645)) * **transformers:** Add WithPrimaryKeys option ([#598](#598)) ([107006c](107006c)) ### Bug Fixes * Send resource validation errors to Sentry ([#601](#601)) ([5916516](5916516)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Merged
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
Our docs show tables based on definition order which can be inconsistent and makes it harder to locate a table, see https://www.cloudquery.io/docs/plugins/sources/azure/tables:
This PR sorts the tables and relations before generating the docs
Use the following steps to ensure your PR is ready to be reviewed
go fmtto format your code 🖊golangci-lint run🚨 (install golangci-lint here)