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

Deduplicate or reconcile Introduction and Terminology pages #327

Closed
negz opened this issue Feb 2, 2023 · 3 comments
Closed

Deduplicate or reconcile Introduction and Terminology pages #327

negz opened this issue Feb 2, 2023 · 3 comments
Assignees

Comments

@negz
Copy link
Member

negz commented Feb 2, 2023

What's Missing?

https://docs.crossplane.io/v1.11/getting-started/introduction/
https://docs.crossplane.io/v1.11/concepts/terminology/

There's a lot of redundancy in these two pages. They define common Crossplane terms, but do so using different language. I think we should either deduplicate them or update them such that the terminology page is a more detailed version of the introduction page. The terminology page also has elements of "style guide" - it talks about how to use certain Crossplane terms. That should probably be moved into part of the docs contribution guide.

@negz
Copy link
Member Author

negz commented Feb 2, 2023

This is something I'd like to work on - I'm strongly opinionated about the nuance of how our core concepts are communicated.

@plumbis
Copy link
Collaborator

plumbis commented Feb 2, 2023

Agreed, this is mainly due to time constraints with the reorg and release. I was trying to not delete things without proper review first.

I think we should remove Terminology and just have two things:

  1. Intro covering the high level for people that are new
  2. Thorough /concepts pages for each Crossplane kind. This would be the in-depth reference for that individual component.

@plumbis plumbis self-assigned this Jul 26, 2023
@plumbis
Copy link
Collaborator

plumbis commented Jul 26, 2023

Fixed in #475

@plumbis plumbis closed this as completed Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants