Skip to content

Commit

Permalink
some edits on the contributing doc for rari (#37295)
Browse files Browse the repository at this point in the history
  • Loading branch information
argl authored Dec 21, 2024
1 parent 494edeb commit 13443ea
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,7 @@ This will make it easier to submit a pull request for your changes.
2. Open a browser and navigate to the equivalent pages you've changed.
If you changed `files/en-us/web/javascript/index.md`, you would navigate to `http://localhost:5042/en-us/docs/web/javascript` in your browser, for example.

3. Check for errors by clicking `Show flaws` on each previewed page.
You may be able to fix flaws by running:

```bash
yarn content flaws <page_slug>
```
3. Check for detected flaws at the top of the previewed page. Some flaws may be automatically fixable.

4. Commit your changes to the branch (our example is using the `fix-typo` branch) and push the changes to your fork's remote:

Expand Down Expand Up @@ -254,7 +249,8 @@ yarn content move <from-slug> <to-slug> [locale]
> See the [Redirecting a document](#redirecting-a-document) section for more information.
To use `yarn content move`, provide the slug of the document you'd like to move (e.g., `Learn/Accessibility`), and the slug of its new location (e.g., `Learn/A11y`).
The locale of the existing document can be provided as an optional third argument (this defaults to `en-US`).
The locale of the existing document can be provided as an optional third argument (this defaults to `en-US`). For other locales,
`CONTENT_TRANSLATED_ROOT` has to be set correctly in your environment.
If the document you'd like to move contains child documents (i.e. it represents a document tree), the `yarn content move` command will move the entire tree.

Let's say you want to move the entire `/en-US/Learn/Accessibility` tree to `/en-US/Learn/A11y`, you can do so as follows:
Expand Down

0 comments on commit 13443ea

Please sign in to comment.