Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make command reference docs consistent #6126

Merged
merged 7 commits into from
Sep 21, 2022
Merged

Make command reference docs consistent #6126

merged 7 commits into from
Sep 21, 2022

Conversation

valaparthvi
Copy link
Contributor

What type of PR is this:
/area documentation
/kind documentation

What does this PR do / why we need it:

Which issue(s) this PR fixes:

Fixes #6000

PR acceptance criteria:

  • Unit test

  • Integration test

  • Documentation

How to test changes / Special notes to the reviewer:
Ensure all the reference docs have a running the command section, and collapsible examples.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. label Sep 15, 2022
@netlify
Copy link

netlify bot commented Sep 15, 2022 •
edited
Loading

✅ Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 6e5ed9c
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/6323510ea8dead0009db813b
😎 Deploy Preview https://deploy-preview-6126--odo-docusaurus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@openshift-ci openshift-ci bot added area/documentation Issues or PRs related to documentation or the 'odo.dev' website kind/documentation labels Sep 15, 2022
@sonarcloud
Copy link

sonarcloud bot commented Sep 15, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.4% 0.4% Duplication

@odo-robot
Copy link

odo-robot bot commented Sep 15, 2022 •
edited
Loading

Unit Tests on commit ffe1dae finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 15, 2022 •
edited
Loading

Validate Tests on commit ffe1dae finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 15, 2022 •
edited
Loading

Kubernetes Tests on commit ffe1dae finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 15, 2022 •
edited
Loading

OpenShift Tests on commit ffe1dae finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 15, 2022 •
edited
Loading

Windows Tests (OCP) on commit ffe1dae finished successfully.
View logs: TXT HTML

@valaparthvi valaparthvi changed the title WIP: Make command reference docs consistent Make command reference docs consistent Sep 20, 2022
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. label Sep 20, 2022
@valaparthvi
Copy link
Contributor Author

The idea is to automate the output by running scripts and ensuring it is up to date. This will help avoid the overhead of manually updating the docs.
Script that runs odo command > Write the output to a .mdx file > Use the .mdx files in the main markdown doc.

@cdrage
Copy link
Member

cdrage commented Sep 20, 2022 •
edited
Loading

This is AWESOME and thank you for making all of this consistent 💯

EDIT: Let's make these changes to the guides too in the future.

/approve

@openshift-ci
Copy link

openshift-ci bot commented Sep 20, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cdrage

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Sep 20, 2022
@cdrage cdrage mentioned this pull request Sep 20, 2022
Closed
@feloy
Copy link
Contributor

feloy commented Sep 21, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 21, 2022
@openshift-merge-robot openshift-merge-robot merged commit 7ee5287 into redhat-developer:main Sep 21, 2022
kadel pushed a commit to kadel/odo that referenced this pull request Oct 3, 2022
@valaparthvi @kadel
Make command reference docs consistent (redhat-developer#6126)
b55f390 
* add-binding.md

* build-images.md

* delete-component.md

* deploy.md

* odo list

* Temp changes

* Add collapsible examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anandrkskd anandrkskd Awaiting requested review from anandrkskd

@dharmit dharmit Awaiting requested review from dharmit

Assignees

@feloy feloy

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. area/documentation Issues or PRs related to documentation or the 'odo.dev' website lgtm Indicates that a PR is ready to be merged. Required by Prow.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make command reference docs consistent
4 participants
@valaparthvi @cdrage @feloy @openshift-merge-robot