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 a glossary for odo terminology #2320

Closed
yhontyk opened this issue Oct 24, 2019 · 6 comments
Closed

Create a glossary for odo terminology #2320

yhontyk opened this issue Oct 24, 2019 · 6 comments
Assignees
Projects

Comments

@yhontyk
Copy link

yhontyk commented Oct 24, 2019

[kind/Documentation]

What did you find missing in the documentation?

Since we have feedback on odo being confusing sometimes, how about adding a glossary in "Understanding odo" which would elaborate on the important terms and explain the relationship/hierarchy between them as well as examples:

  • project
  • application
  • component
  • something else?

Maybe a visual representation - a diagram of some sorts could help?

Cc @kadel @cdrage @dharmit

What is the relevance of it?

Make docs better!

@yhontyk yhontyk self-assigned this Oct 24, 2019
@dharmit
Copy link
Member

dharmit commented Oct 24, 2019

+1 to having glossary. I remember asking @kadel about what a 'component' means during my initial days in the team and irrespective of how much he tried, I just couldn't understand the concept completely. Eventually I accepted it as something abstract. A group of things forming up a component. Even then, it used to confuse me if a URL should be a part of the umbrella that makes up a component or not.

+100 to having a visual representation or an architecture diagram for various things that make up odo.

@girishramnani girishramnani added this to For consideration in Sprint 175 via automation Nov 4, 2019
@girishramnani girishramnani moved this from For consideration to To do in Sprint 175 Nov 4, 2019
@kadel
Copy link
Member

kadel commented Nov 6, 2019

@kadel kadel removed this from To do in Sprint 175 Nov 25, 2019
@kadel kadel added this to For consideration in Sprint 176 via automation Nov 25, 2019
@yhontyk yhontyk moved this from For consideration to In progress in Sprint 176 Nov 27, 2019
@kadel kadel added this to For consideration in Sprint 177 via automation Dec 16, 2019
@kadel kadel removed this from In progress in Sprint 176 Dec 16, 2019
@kadel kadel moved this from For consideration to In progress in Sprint 177 Dec 16, 2019
@girishramnani
Copy link
Contributor

@boczkowska @pmacko1 could you please add an update on this issue?

@girishramnani girishramnani assigned ghost Dec 18, 2019
@ghost
Copy link

ghost commented Jan 6, 2020

I was not working on this issue, @boczkowska could you provide an update, please?

@yhontyk
Copy link
Author

yhontyk commented Jan 6, 2020

Done here: openshift/openshift-docs#18477

@girishramnani
Copy link
Contributor

As the PR was merged, we can close this issues

Sprint 177 automation moved this from In progress to Done Jan 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Sprint 177
  
Done
Development

No branches or pull requests

5 participants