Document the org_config Object #3490
Merged
+62
−1
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
yippie
approved these changes
Mar 9, 2023
|
More documentation is always good! |
|
@RupertBarrow thanks for this! |
|
Hi @yippie , is anyone going to merge this PR one day ? |
after reading about has_minimum_package_version() in https://trailhead.salesforce.com/fr/trailblazer-community/feed/0D54V00007erukZSAQ
|
I just update this documentation after reading about |
jstvz
previously requested changes
Nov 16, 2024
There was a problem hiding this comment.
Thank you for your contribution, @RupertBarrow. Apologies for the delay in reviewing it.
Just a needs a few tweaks before we merge it.
Co-authored-by: James Estevez <[email protected]>
auto-merge was automatically disabled
December 13, 2024 16:04
Head branch was pushed to by a user without write access
Co-authored-by: James Estevez <[email protected]>
Co-authored-by: James Estevez <[email protected]>
vsbharath
approved these changes
Jan 17, 2025
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.
To fix #2424, I have created a document called
org_config.mdunder docs, and added this paragraph to thereference.mdchapter.At the same time, I fixed the name of the env-var-reference chapter which was incorrectly referenced in
reference.mdand, thus, did not appear in the generated documentation.I scoured the source code for these attributes, leaving out the attributes with names starting with an underscore, as well as
salesforce_clientandtoolingwhich sound like reserved for internal use.I guessed the use of most of the attributes from their name. When in doubt, I left attributes with unknown use in a separate list.