fix: update paths for monorepo

This commit is contained in:
Yangshun Tay 2019-03-23 21:53:32 -07:00
parent 73b89658cc
commit 1602b459da
14 changed files with 24 additions and 9 deletions

7
.github/CODEOWNERS vendored
View file

@ -1,2 +1,7 @@
# https://help.github.com/articles/about-codeowners/ # https://help.github.com/articles/about-codeowners/
/v2/ @endiliey
/packages/docusaurus-1.x/ @endiliey
/packages/docusaurus-init-1.x/ @endiliey
/packages/docusaurus/ @endiliey @yangshun
/website/ @endiliey @yangshun
/website-1.x/ @endiliey @yangshun

View file

@ -3,6 +3,11 @@ name: 🚀 Feature
about: Submit a proposal/request for a new feature about: Submit a proposal/request for a new feature
--- ---
<!--
Consider requesting the feature on https://docusaurus-2.netlify.com/feedback/ instead.
Feature requests on v1 will not be accepted easily as we're focusing on building v2.
-->
## 🚀 Feature ## 🚀 Feature
(A clear and concise description of what the feature is.) (A clear and concise description of what the feature is.)

View file

@ -3,6 +3,11 @@ name: 💥 Proposal
about: Propose a non-trivial change to Docusaurus about: Propose a non-trivial change to Docusaurus
--- ---
<!--
Consider requesting the feature on https://docusaurus-2.netlify.com/feedback/ instead.
Feature requests on v1 will not be accepted easily as we're focusing on building v2.
-->
## 💥 Proposal ## 💥 Proposal
(A clear and concise description of what the proposal is.) (A clear and concise description of what the proposal is.)

View file

@ -13,7 +13,7 @@ There are many ways to contribute to Docusaurus, and many of them do not involve
- Simply start using Docusaurus. Go through the [Getting Started](https://docusaurus.io/docs/en/installation.html) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues). - Simply start using Docusaurus. Go through the [Getting Started](https://docusaurus.io/docs/en/installation.html) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Look through the [open issues](https://github.com/facebook/docusaurus/issues). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests). - Look through the [open issues](https://github.com/facebook/docusaurus/issues). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests).
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/facebook/docusaurus/labels/Good%20first%20issue) are a good place to get started. - If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/facebook/docusaurus/labels/Good%20first%20issue) are a good place to get started.
- Read through the [Docusaurus docs](https://docusaurus.io/docs/en/installation.html). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs. - Read through the [Docusaurus docs](https://docusaurus.io/docs/en/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs.
- Take a look at the [features requested](https://github.com/facebook/docusaurus/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on. - Take a look at the [features requested](https://github.com/facebook/docusaurus/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.
Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help. Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help.
@ -23,7 +23,7 @@ Contributions are very welcome. If you think you need help planning your contrib
If you only want to make content changes you just need to know about versioned docs. If you only want to make content changes you just need to know about versioned docs.
- `/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/en/next/installation. - `/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/en/next/installation.
- `v1/website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/en/X.Y.Z/installation. - `website-1.x/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/en/X.Y.Z/installation.
To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL). To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL).
@ -44,7 +44,7 @@ One great way you can contribute to the project without writing any code is to h
Docusaurus uses [GitHub](https://github.com/facebook/docusaurus) as its source of truth. The core team will be working directly there. All changes will be public from the beginning. Docusaurus uses [GitHub](https://github.com/facebook/docusaurus) as its source of truth. The core team will be working directly there. All changes will be public from the beginning.
When a change made on GitHub is approved, it will be checked by our continuous integration system, CircleCI. When a change made on GitHub is approved, it will be checked by our continuous integration system, Circle CI.
### Branch organization ### Branch organization
@ -78,8 +78,8 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
1. Ensure you have [Yarn](https://yarnpkg.com/) installed. 1. Ensure you have [Yarn](https://yarnpkg.com/) installed.
1. After cloning the repository, run `yarn install` in the root of the repository. 1. After cloning the repository, run `yarn install` in the root of the repository.
- For Docusaurus 1 development, go into the `v1` directory and do `yarn install`. - For Docusaurus 1 development, look into the `packages/docusaurus-1.x` and `website-1.x` directory.
- For Docusaurus 2 development, go into the `v2` directory and do `yarn install`. - For Docusaurus 2 development, go into the `packages/docusaurus` and `website` directory.
1. Run `yarn start` in the respective project directory to start a local development server serving the Docusaurus docs. 1. Run `yarn start` in the respective project directory to start a local development server serving the Docusaurus docs.
@ -137,7 +137,7 @@ When adding a new breaking change, follow this template in your pull request:
- **Severity (number of people affected x effort)**: - **Severity (number of people affected x effort)**:
``` ```
#### Copyright Notice for code files #### Copyright Header for Source Code
Copy and paste this to the top of your new file(s): Copy and paste this to the top of your new file(s):

0
packages/docusaurus-1.x/lib/build-files.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/copy-examples.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/publish-gh-pages.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/rename-version.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/start-server.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/version.js Normal file → Executable file
View file

0
packages/docusaurus-1.x/lib/write-translations.js Normal file → Executable file
View file

0
packages/docusaurus-init-1.x/initialize.js Normal file → Executable file
View file

0
packages/docusaurus/bin/docusaurus.js Normal file → Executable file
View file

View file

@ -29,14 +29,14 @@ select VERSION in patch minor major "Specific Version"
if [[ $REPLY =~ ^[Yy]$ || -z $REPLY ]]; then if [[ $REPLY =~ ^[Yy]$ || -z $REPLY ]]; then
# Bump version # Bump version
cd v1 cd packages/docusaurus-1.x
yarn version --new-version $VERSION --no-git-tag-version yarn version --new-version $VERSION --no-git-tag-version
NEW_VERSION=$(node -p "require('./package.json').version") NEW_VERSION=$(node -p "require('./package.json').version")
# Create new branch # Create new branch
git checkout -B $NEW_VERSION master git checkout -B $NEW_VERSION master
# Cut docusaurus docs version # Cut docusaurus docs version
cd website && yarn $DOCS_VERSION_COMMAND $NEW_VERSION cd ../website-1.x && yarn $DOCS_VERSION_COMMAND $NEW_VERSION
# Create commit # Create commit
git add ../ git add ../