Improve documentation related to "Create …" form and scenario definitions #5949
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
|
Great PR! Please pay attention to the following items before merging: Files matching
This is an automatically generated QA checklist based on modified files. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5949 +/- ##
=======================================
Coverage 98.75% 98.75%
=======================================
Files 396 396
Lines 38966 38966
=======================================
Hits 38479 38479
Misses 487 487 ☔ View full report in Codecov by Sentry. |
kalikiana
reviewed
Sep 26, 2024
Martchus
force-pushed
the
new-job-help
branch
2 times, most recently
from
46a5c6b
to
f77d11e
Compare
perlpunk
approved these changes
Sep 26, 2024
okurz
reviewed
Sep 26, 2024
Martchus
force-pushed
the
new-job-help
branch
from
f77d11e
to
cc168c0
Compare
okurz
approved these changes
Sep 27, 2024
* Fix the description which wrongly states that a product and a machine are required; no product and machine definitions are specified in the example and this is also not necessary * Add a machine name to the job templates because the dependency resolution needs a machine * Explain what this example actually does and point to another example that contains product and machine definitions to also have an example for that
* Add an example that is a bit more comprehensive than the minimum one from the documentation to at least have all the possible keys at the root (so one does not have to type them if required) * Show dependency creation and asset publishing like in the example documentation because it makes a nice skeleton demonstrating a common use case * Clarify implicitly that the YAML document itself needs to go into the form (and not a URL or path) * See https://progress.opensuse.org/issues/166658#note-15
Martchus
force-pushed
the
new-job-help
branch
from
cc168c0
to
15c40e2
Compare
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.
See particular commit messages https://progress.opensuse.org/issues/166658#note-15