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.

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

Create dropdown menus for examples for user guides / other documentation. #6143

Closed
cdrage opened this issue Sep 20, 2022 · 6 comments · Fixed by #6439
Closed

Create dropdown menus for examples for user guides / other documentation. #6143

cdrage opened this issue Sep 20, 2022 · 6 comments · Fixed by #6439
Assignees
Labels
area/documentation Issues or PRs related to documentation or the 'odo.dev' website good first issue Denotes an issue ready for a new contributor. Maintainers will help mentor new contributors. kind/bug Categorizes issue or PR as related to a bug.
Milestone

Comments

@cdrage
Copy link
Member

cdrage commented Sep 20, 2022

/area documentation
/kind bug

What mistake did you find / what is missing in the documentation?

See: #6126

We should make the example output as dropdown menus as well on all the tutorial guides / etc.

What is the relevance of it?

Cleaner and looks better! :)

@openshift-ci openshift-ci bot added area/documentation Issues or PRs related to documentation or the 'odo.dev' website kind/bug Categorizes issue or PR as related to a bug. labels Sep 20, 2022
@rm3l rm3l added this to odo Project Oct 3, 2022
@rm3l rm3l moved this to To Do 📝 in odo Project Oct 3, 2022
@rm3l rm3l removed the status in odo Project Oct 3, 2022
@SD-13
Copy link
Contributor

SD-13 commented Oct 26, 2022

Hi @cdrage, Can I take this one?

@cdrage
Copy link
Member Author

cdrage commented Oct 26, 2022

Go ahead, but just check with @valaparthvi as she may have updated the site already with this :)

@valaparthvi
Copy link
Contributor

Hi @SD-13, you can start by working on the Quickstart guides.
For reference, you can take a look at https://odo.dev/docs/overview/configure.

@SD-13
Copy link
Contributor

SD-13 commented Oct 27, 2022

Hi @SD-13, you can start by working on the Quickstart guides.
For reference, you can take a look at https://odo.dev/docs/overview/configure.

Sure, I will look into it and will reach out to you if I have any query. Thanks,

@valaparthvi
Copy link
Contributor

Add a sample output for the following pages:

  1. https://odo.dev/docs/user-guides/advanced/connecting-a-service#step-5-exit-and-cleanup: odo remove binding --name my-go-app-mongodb-instance
  2. https://odo.dev/docs/user-guides/advanced/experimental-mode#enabling-the-experimental-mode
  3. https://odo.dev/docs/command-reference/list-services
  4. https://odo.dev/docs/command-reference/set-namespace: Replace odo set namespace mynamespace with odo set namespace <namespace> and same for the project command.

@SD-13 These are the remaining pages that needs an update. You can assign the issue to yourself if you would like to fix them.

@SD-13
Copy link
Contributor

SD-13 commented Dec 22, 2022

I would love to do that😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation or the 'odo.dev' website good first issue Denotes an issue ready for a new contributor. Maintainers will help mentor new contributors. kind/bug Categorizes issue or PR as related to a bug.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants