Skip to content

Commit

Permalink
Merge pull request #10 from hpi-schul-cloud/update-readme
Browse files Browse the repository at this point in the history
update README.md -> remove build by script step
  • Loading branch information
EzzatOmar authored Oct 17, 2023
2 parents d87ead0 + 358592f commit ce72aac
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

This website is a documentation aggregator for all Schulcloud-Verbund software.

It is deployed at https://hpi-schul-cloud.github.io/schulcloud-documentation/
It is deployed at https://documentation.dbildungscloud.dev/

**the domain is subject to change**

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

Expand Down Expand Up @@ -32,12 +31,14 @@ $ npm run build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Update the docs

Create a new branch. Change the /docs files.

### Deployment

Using SSH:
Create a pull request and once your changes are merged into main the website will automatically deploy the new version.

```
$ USE_SSH=true DEPLOYMENT_BRANCH=gh-pages npm run deploy
```
### Important

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Do not remove the branch `gh-pages`. This branch is auto generated and contains the hosted website.

0 comments on commit ce72aac

Please sign in to comment.