Update file reference documentation #3675
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
**What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` /kind documentation [skip ci] **What does does this PR do / why we need it**: Updates the file reference documentation to not have the introductory section and move unsupported features to the bottom. **Which issue(s) this PR fixes**: N/A **PR acceptance criteria**: N/A **How to test changes / Special notes to the reviewer**: N/A Signed-off-by: Charlie Drage <charlie@charliedrage.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
cdrage
added a commit
that referenced
this pull request
Aug 4, 2020
* Adds documentation on Devfile file reference (#3487) **What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` > Documentation changes: Please include [skip ci] in your commit message as well /kind documentation [skip ci] **What does does this PR do / why we need it**: This PR adds documentation regarding each section of Devfile and what we support / do not support **Which issue(s) this PR fixes**: N/A **How to test changes / Special notes to the reviewer**: N/A Signed-off-by: Charlie Drage <charlie@charliedrage.com> * Update file reference documentation (#3675) **What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` /kind documentation [skip ci] **What does does this PR do / why we need it**: Updates the file reference documentation to not have the introductory section and move unsupported features to the bottom. **Which issue(s) this PR fixes**: N/A **PR acceptance criteria**: N/A **How to test changes / Special notes to the reviewer**: N/A Signed-off-by: Charlie Drage <charlie@charliedrage.com> * make odo delete work on s2i components in experimental mode (#3649) * Fixes GetRunningPodNameByComponent for the CLI runners (#3666) * increase ResponseHeaderTimeout (#3674) * Make the file sync destination more consistent (#3662) * Make the file sync destination more consistent Signed-off-by: John Collier <John.J.Collier@ibm.com> * Update tests to use PROJECTS_ROOT Signed-off-by: John Collier <John.J.Collier@ibm.com> * Fix workdir in tests Signed-off-by: John Collier <John.J.Collier@ibm.com> * Remove more references to nodejs-starter Signed-off-by: John Collier <John.J.Collier@ibm.com> * Update more sample devfiles Signed-off-by: John Collier <John.J.Collier@ibm.com> * make odo catalog list components work outside of experimental mode (#3669) * make odo catalog list components work outside of experimental mode * moved the logic to cli * Ignore error while checking for imagestream support * rearranged the catalog list * Validate exec subcommands in a composite (#3658) * Validate exec subcommands in composite * Add integration test * added --s2i flag for `odo create` command * corrected error messages * Corrected flag description and validation * added --s2i flag for `odo create` command * Make Devfile the default deployment mechanism for odo **What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` /kind feature **What does does this PR do / why we need it**: Makes Devfile the default deployment mechanism, removing S2I in favour of Devfile deployment. **Which issue(s) this PR fixes**: Closes #3550 **How to test changes / Special notes to the reviewer**: Run: ```sh odo preference set experimental false odo create --starter nodejs odo push ``` Co-authored-by: Girish Ramnani <girishramnani95@gmail.com> Co-authored-by: Mrinal Das <mrinald7@gmail.com> Co-authored-by: Tomas Kral <tkral@redhat.com> Co-authored-by: John Collier <John.J.Collier@ibm.com> Co-authored-by: Devang Gaur <devang.gaur.7@gmail.com>
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.
What type of PR is this?
/kind documentation
[skip ci]
What does does this PR do / why we need it:
Updates the file reference documentation to not have the introductory
section and move unsupported features to the bottom.
Which issue(s) this PR fixes:
N/A
PR acceptance criteria:
N/A
How to test changes / Special notes to the reviewer:
N/A
Signed-off-by: Charlie Drage charlie@charliedrage.com