paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

Docs updates

Browse Source 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Bodil Björklund <bodilb@spotify.com>
This commit is contained in:
Emma Indal
2022-02-17 13:35:47 +01:00
parent 4b574efb65
commit 21d4ee819f
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-cli/README.md
+7 -7
View File
@@ -40,9 +40,9 @@ yarn start
yarn techdocs-cli:dev [...options]
```
### Use an example docs project
### Using an example docs project
We have created an [example documentation project](https://github.com/backstage/techdocs-container/tree/main/mock-docs) and it's shipped with [techdocs-container](https://github.com/backstage/techdocs-container) repository, for the purpose of local development. But you are free to create your own local test site. All it takes is a `docs/index.md` and `mkdocs.yml` in a directory.
For the purpose of local development, we have created an [example documentation project](https://github.com/backstage/techdocs-container/tree/main/mock-docs) which is shipped with the [techdocs-container](https://github.com/backstage/techdocs-container) repository. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory.
```sh
git clone https://github.com/backstage/techdocs-container.git
@@ -67,17 +67,17 @@ pip install mkdocs-techdocs-core
Then run `yarn test`.
#### Run Cypress tests
#### Running Cypress tests
Running cypress tests requires you to run the CLI locally against our example docs project
Running cypress tests requires you to run the CLI locally against our example docs project.
Start by making sure you have the example project locally on your computer
Start by making sure that you have the example project locally on your computer:
```sh
git clone https://github.com/backstage/techdocs-container.git
```
Run the local version of techdocs-cli against the example docs project
Run the local version of techdocs-cli against the example docs project:
```sh
# From the root of this repository run
@@ -91,7 +91,7 @@ cd techdocs-container/mock-docs
../../backstage/packages/techdocs-cli/bin/techdocs-cli serve
```
Run the cypress tests
Run the cypress tests:
```sh
yarn cypress:open