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

[Feature]: docs metadata configuration for v9 #26280

Closed
1 task done
Hotell opened this issue Jan 10, 2023 · 2 comments
Closed
1 task done

[Feature]: docs metadata configuration for v9 #26280

Hotell opened this issue Jan 10, 2023 · 2 comments

Comments

@Hotell
Copy link
Contributor

Hotell commented Jan 10, 2023

Library

React Components / v9 (@fluentui/react-components)

Describe the feature that you would like added

Current component workflow is like following:

flowchart TB


A["new package"];
B["alpha release"]
C["beta/RC release"]
D["add to react-components unstable"]
DP["stories exposed to Docs"]

subgraph one["package release stage"]
A --> B --> C;
end

C -...-> D

subgraph two["package docs exposure"]
D --> DP
end
Loading

Scenario:

  • package is added to unstable/stable for react-components. We don't wanna render its stories in docsite

Proposal:

Introduce new package.json metadata field, with following API:

{
 "name": "@fluentui/new-package"
 "docs": { "enabled": false }
}

By default it will be false so the existing workflow will be a bit different. it will be package author responsibility to mark this to true once he is sure that stories can land in public docsite.

This can be automated as part of upcoming API propagation automation: nx workspace-generator add-package-to-react-components --name=@fluentui/new-package --access=unstable --docs

Have you discussed this feature with our team

v-build

Additional context

No response

Validations

  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@msft-fluent-ui-bot
Copy link
Collaborator

Because this issue has not had activity for over 150 days, we're automatically closing it for house-keeping purposes.

Still require assistance? Please, create a new issue with up-to date details.

@msft-fluent-ui-bot msft-fluent-ui-bot added the Resolution: Soft Close Soft closing inactive issues over a certain period label Jun 9, 2023
@Hotell Hotell reopened this Jun 13, 2023
@Hotell
Copy link
Contributor Author

Hotell commented Jul 19, 2023

we switched to new preview(unstable) packages release approach which makes this feature not needed.

on 1st preview release - package stories will be added to public-docsite automatically

closing as wont implement/superseded by #28471

@Hotell Hotell closed this as completed Jul 19, 2023
@Hotell Hotell removed the Resolution: Soft Close Soft closing inactive issues over a certain period label Jul 20, 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