Documentation: consistent header levels and same doc structure #3007
Conversation
This file contains 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
In a number of resources the header levels were inconsistent for documentation about blocks (some were on 2nd level, some on 3rd, while most of resources use 3rd level). Also change order of sections a bit to get uniform order.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #3007 +/- ##
==========================================
- Coverage 84.30% 84.26% -0.04%
==========================================
Files 158 158
Lines 13835 13830 -5
==========================================
- Hits 11663 11654 -9
- Misses 1523 1525 +2
- Partials 649 651 +2 |
nkvuong
reviewed
Dec 8, 2023
| @@ -405,7 +405,7 @@ resource "databricks_job" "sql_aggregation_job" { | |||
| } | |||
| ``` | |||
|
|
|||
| ### Exported attributes | |||
There was a problem hiding this comment.
Have you replaced all the instances of this in the doc?
There was a problem hiding this comment.
yes, it was only one place with such a name - everything else uses "Attribute Reference"
nkvuong
approved these changes
Dec 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
In a number of resources the header levels were inconsistent for documentation about blocks (some were on the 2nd level, some on the 3rd, while most of the resources use the 3rd level). Also, changed the order of sections a bit to get a uniform order of sections.
Tests
make testrun locallydocs/folderinternal/acceptance