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

Link to Composition Revisions, Functions, etc from "main" Composition docs #323

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

Comments

@negz
Copy link
Member

negz commented Feb 2, 2023

What's Missing?

I want to keep non-GA Composition features like Revisions and Functions "contained" - separate from the documentation of GA features. I believe this removes any ambiguity around what features are GA and what features folks should be more conscious of opting into. This makes discoverability tricky though, per the below feedback:

Screenshot 2023-02-01 at 4 36 46 PM

One compromise that comes immediately to mind would be to cross-link. Have the Composition docs link to the pages of any alpha or beta features, and have those features link back to the broader Composition docs.

@plumbis
Copy link
Collaborator

plumbis commented Feb 2, 2023

I would argue that the KB is currently the wrong home for the Composite Functions page, since it is specific to v1.11. As future are release the capabilities and rules of of CompFn are likely to evolve making the doc version-dependent.

Since it's a new kind I would say this should live under /concepts.

@negz
Copy link
Member Author

negz commented Feb 2, 2023

I would argue that the KB is currently the wrong home for the Composite Functions page, since it is specific to v1.11.

Agreed - I raised #316 yesterday to discuss that.

Since it's a new kind I would say this should live under /concepts.

It's actually not a new kind (or more specifically it introduces no new CRD - FunctionIO is kind of special). Instead it's an extension of the kind: Composition type. This makes finding a home a bit tricky. If the feature were GA today I would say it should be part of the Composition documentation. The only reason I want to keep it separate for now is because it's pre-GA and I want to make it as easy as possible for readers to delineate GA stuff from not-yet-GA stuff.

@plumbis
Copy link
Collaborator

plumbis commented Jul 26, 2023

Fixed in #475

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

No branches or pull requests

2 participants