diff --git a/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml b/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml index e369b5c19f77..80eae3464f9f 100644 --- a/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml +++ b/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml @@ -131,7 +131,7 @@ body: options: - label: I agree to follow this project's [Code of - Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) + Conduct](https://github.com/carbon-design-system/carbon/blob/main/docs/CODE_OF_CONDUCT.md) required: true - label: I checked the [current diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml index a1d9d722c1bf..ddf98f7e6ab8 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml @@ -113,7 +113,7 @@ body: options: - label: I agree to follow this project's [Code of - Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) + Conduct](https://github.com/carbon-design-system/carbon/blob/main/docs/CODE_OF_CONDUCT.md) required: true - label: I checked the [current diff --git a/.github/ISSUE_TEMPLATE/DESIGN_DEFECT.yaml b/.github/ISSUE_TEMPLATE/DESIGN_DEFECT.yaml index b203f018f945..a0d8315b8907 100644 --- a/.github/ISSUE_TEMPLATE/DESIGN_DEFECT.yaml +++ b/.github/ISSUE_TEMPLATE/DESIGN_DEFECT.yaml @@ -87,7 +87,7 @@ body: options: - label: I agree to follow this project's [Code of - Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) + Conduct](https://github.com/carbon-design-system/carbon/blob/main/docs/CODE_OF_CONDUCT.md) required: true - label: I checked the [current diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml index 37a93001e14d..dbf24b425b34 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml @@ -64,5 +64,5 @@ body: options: - label: I agree to follow this project's [Code of - Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) + Conduct](https://github.com/carbon-design-system/carbon/blob/main/docs/CODE_OF_CONDUCT.md) required: true diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yaml b/.github/ISSUE_TEMPLATE/QUESTION.yaml index 0ec1683555b8..df3cb78f6bb0 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yaml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yaml @@ -49,5 +49,5 @@ body: options: - label: I agree to follow this project's [Code of - Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) + Conduct](https://github.com/carbon-design-system/carbon/blob/main/docs/CODE_OF_CONDUCT.md) required: true diff --git a/.github/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from .github/CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index fc943453562f..12840d6924b9 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -13,7 +13,7 @@ to the Carbon community. We value all of our community members, and thus want to foster a positive contributing environment. Please take a look at our -[code of conduct](./CODE_OF_CONDUCT.md) before engaging in our workspaces. +[code of conduct](CODE_OF_CONDUCT.md) before engaging in our workspaces. ## Prerequisites @@ -29,7 +29,7 @@ installed: version manager for Node. - Git - [Yarn](https://yarnpkg.com/en/docs/install) -- [WSL](../docs/guides/setup/windows.md) (Windows Only) +- [WSL](guides/setup/windows.md) (Windows Only) If you're using Windows, there are some [additional steps](https://github.com/carbon-design-system/carbon/blob/main/docs/guides/setup/windows.md) @@ -261,8 +261,8 @@ GitHub. - **Development:** If coding is your thing, you can help us by contributing bug fixes or community components. Checkout our - [Developer Handbook](../docs/developer-handbook.md) to get your dev - environment set up, read up on our best practices and more. + [Developer Handbook](developer-handbook.md) to get your dev environment set + up, read up on our best practices and more. - **Design:** Design contributions can vary from visual assets, UX interactions, motion design, Sketch kit bug fixes and more. - **Content:** Our documentation is just as important as our design and code @@ -285,9 +285,8 @@ GitHub. out properly according to the issue template. 2. **Development environment:** If you haven't already, fork and clone whichever repo you want to contribute to. Then, create a new branch and add your - contribution in it. Checkout our - [Developer Handbook](../docs/developer-handbook.md) to read up on our best - coding practices and proper commit messages. + contribution in it. Checkout our [Developer Handbook](developer-handbook.md) + to read up on our best coding practices and proper commit messages. 3. **Pull request:** Submit a PR. Be sure to fill out the template properly. 4. **Developer Certificate of Origin:** In order to contribute any code, we need you to sign a Developer Certificate of Origin (DCO). Code doesn't just mean diff --git a/docs/README.md b/docs/README.md index c27b75ad880d..401cbf5bdf74 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,7 @@ Maintained with Lerna - + PRs welcome @@ -66,8 +66,6 @@ we support! - See our documentation site [here](https://www.carbondesignsystem.com/developing/frameworks/react/) for full how-to docs and guidelines -- [Contributing](/.github/CONTRIBUTING.md): Guidelines for making contributions - to this repo. - 🏃‍♀️ Migration Guides - [v10 to v11](migration/v11.md) - [v9 to v10 (vanilla)](../packages/carbon-components/docs/migration/migrate-to-10.x.md) @@ -77,7 +75,7 @@ we support! We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely -check out our [Contributing Guide](/.github/CONTRIBUTING.md) and our +check out our [Contributing Guide](CONTRIBUTING.md) and our [Developer Guide](developer-handbook.md)! 👀 ## Contributors diff --git a/docs/guides/release-partners.md b/docs/guides/release-partners.md index 1ef5cdcdb36b..44bf7f8d0af7 100644 --- a/docs/guides/release-partners.md +++ b/docs/guides/release-partners.md @@ -202,7 +202,7 @@ entrypoint. This entrypoint is temporary during v10 and will be moved to `@carbon/icons-react` in v11. For more details on migrating from the v10 icons to v11, check out our -[migration guide](../migration/11.md). +[migration guide](../migration/v11.md). _Note: there will be a codemod to help with automatically updating icon usage in our next beta release_ diff --git a/docs/postmortems/README.md b/docs/postmortems/README.md index 7eca1d9fd5ed..7df2109c797f 100644 --- a/docs/postmortems/README.md +++ b/docs/postmortems/README.md @@ -12,7 +12,7 @@ topic [here](https://landing.google.com/sre/sre-book/chapters/postmortem/). ## Process -- Copy the [Postmortem template](./00-template.md) over to a new file +- Copy the [Postmortem template](./0000-00-00-template.md) over to a new file - This file should be named: `YYYY-MM-DD-title.md` - For example: `10-11-05-critical-layout-breaking-change.md` - Fill out the template as best you can, be as detailed as needed