[DOC] (RADICAL) Improve Job documentation structure #3511
Merged
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
landlord-matt
requested review from
hectorcast-db
and removed request for
a team
|
Any thoughts on any of these two suggestions (repurposing the top of the argument reference as index and grouping the task parameters)? I guess it is not trivial to structure given that some of the arguments can be placed on both job and task level. Perhaps main commiter @alexott? |
alexott
approved these changes
May 2, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3511 +/- ##
==========================================
- Coverage 82.71% 82.70% -0.02%
==========================================
Files 183 183
Lines 18827 18827
==========================================
- Hits 15573 15571 -2
- Misses 2339 2340 +1
- Partials 915 916 +1 |
|
Thank you @landlord-matt ! |
mgyucht
added a commit
that referenced
this pull request
May 3, 2024
### New Features and Improvements * Allow changes to `display_name` for `databricks_service_principal` ([#3523](#3523)). * Modify `databricks_repo` to support Git folders in the workspace ([#3447](#3447)). * Retry requests in the Databricks Go SDK until context timeout ([#3537](#3537)). * Set ForceSendFields for boolean/integer values explicitly set to false/0 ([#3385](#3385)). ### Bug fixes * Added `ConflictsWith` to legacy tasks in `databricks_job` to avoid errors when job parameters are used ([#3500](#3500)). * Fixed spn secret permanent diff ([#3525](#3525)). * Introduced `common.NoClientData` helper function and use it in `databricks_aws_crossaccount_policy` data source to allow its use with workspace- or account-level providers ([#3508](#3508)). * Set `id` attribute of `databricks_metastore` data source ([#3503](#3503)). ### Documentation Changes * Added documentation for compute options for tasks in `databricks_job` resource ([#3504](#3504)). * Added warning about depends_on order ([#3489](#3489)). * Fixed various doc typos ([#3512](#3512)). * Fixed `databricks_current_metastore` data source names in docs examples ([#3515](#3515)). * Improved Job documentation structure ([#3511](#3511)). * Removed confusing mention of cloud types for `databricks_clusters` and `databricks_sql_warehouses` data sources ([#3518](#3518)). ### Exporter * Added UC support for DLT pipelines ([#3494](#3494)). * Ignored instance pools with the empty name ([#3522](#3522)). ### Internal Changes * Added DATABRICKS_USER_AGENT_EXTRA ([#3520](#3520)). * Adjusted list of supported platforms in `godownloader-databricks-provider.sh` ([#3527](#3527)). * Switched to Go SDK for `databricks_directory` resource and data source ([#3509](#3509)). * Fixed codecov for repository ([#3530](#3530)). Dependency updates: * Bump databricks-sdk-go to v0.40.0 ([#3534](#3534)).
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 3, 2024
* Release v1.42.0 ### New Features and Improvements * Allow changes to `display_name` for `databricks_service_principal` ([#3523](#3523)). * Modify `databricks_repo` to support Git folders in the workspace ([#3447](#3447)). * Retry requests in the Databricks Go SDK until context timeout ([#3537](#3537)). * Set ForceSendFields for boolean/integer values explicitly set to false/0 ([#3385](#3385)). ### Bug fixes * Added `ConflictsWith` to legacy tasks in `databricks_job` to avoid errors when job parameters are used ([#3500](#3500)). * Fixed spn secret permanent diff ([#3525](#3525)). * Introduced `common.NoClientData` helper function and use it in `databricks_aws_crossaccount_policy` data source to allow its use with workspace- or account-level providers ([#3508](#3508)). * Set `id` attribute of `databricks_metastore` data source ([#3503](#3503)). ### Documentation Changes * Added documentation for compute options for tasks in `databricks_job` resource ([#3504](#3504)). * Added warning about depends_on order ([#3489](#3489)). * Fixed various doc typos ([#3512](#3512)). * Fixed `databricks_current_metastore` data source names in docs examples ([#3515](#3515)). * Improved Job documentation structure ([#3511](#3511)). * Removed confusing mention of cloud types for `databricks_clusters` and `databricks_sql_warehouses` data sources ([#3518](#3518)). ### Exporter * Added UC support for DLT pipelines ([#3494](#3494)). * Ignored instance pools with the empty name ([#3522](#3522)). ### Internal Changes * Added DATABRICKS_USER_AGENT_EXTRA ([#3520](#3520)). * Adjusted list of supported platforms in `godownloader-databricks-provider.sh` ([#3527](#3527)). * Switched to Go SDK for `databricks_directory` resource and data source ([#3509](#3509)). * Fixed codecov for repository ([#3530](#3530)). Dependency updates: * Bump databricks-sdk-go to v0.40.0 ([#3534](#3534)). * Changelog
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
It seems the number of parameters has outgrown the current structure of the job documentation. This PR ensures that
Tests
make testrun locallydocs/folderinternal/acceptance