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

Update documentation to reflect the deprecation of carbon-components and carbon-components-react #12497

Closed
9 of 11 tasks
Tracked by #12494
tay1orjones opened this issue Nov 3, 2022 · 1 comment · Fixed by #17615
Closed
9 of 11 tasks
Tracked by #12494

Comments

@tay1orjones
Copy link
Member

tay1orjones commented Nov 3, 2022

As part of the plan to deprecate these packages, the following documentation needs to be updated:

Docs to update

Preview Give feedback

Options for longform documentation explanations

Options include

  1. Create carbondesignsystem.com/deprecated-carbon-components and carbondesignsystem.com/deprecated-carbon-components-react that is not visible in the left nav
  2. A GitHub discussion(s) (but maybe we don't want or need a comments section? or could the discussion prevent issues from being opened asking about the deprecation?)
  3. A section on the package readme in addition to the deprecation notice at the top of the file

Benefits of 1 and 2, the GitHub options, include that we can get a permalink to a discussion/readme. Whereas on the website it might be easy to forget the pages exists and/or keep it updated.

@tay1orjones tay1orjones changed the title Update documentation to reflect the deprecation of carbon-components and carbon-components-react Update documentation to reflect the deprecation of carbon-components and carbon-components-react Nov 3, 2022
@tay1orjones tay1orjones added this to the 2023 Q2 milestone Nov 16, 2022
@tay1orjones tay1orjones added the version: 12 Issues pertaining to a future major release of Carbon label Mar 24, 2023
@tay1orjones tay1orjones removed this from the 2023 Q2 milestone Mar 24, 2023
@tay1orjones tay1orjones moved this to Icebox in Roadmap Mar 24, 2023
@sstrubberg sstrubberg moved this from Icebox to v12 in Roadmap Aug 22, 2023
@tay1orjones
Copy link
Member Author

This isn't specifically blocked by v12 - we can continue to update these packages (though we do not intend to) even after deprecation. The only v12-blocked item is removing the source of these packages from the repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants