QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-19 08:04:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation on updating documentation. (#20400)

Browse Source
This commit is contained in:
Cody Leff
2022-06-16 15:05:37 -06:00
committed by GitHub
parent a8a6b732e9
commit fadf0ec5ad
2 changed files with 22 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/README.md
View File

@@ -17,36 +17,4 @@ specific language governing permissions and limitations
under the License.
-->
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn install
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```
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.
This is the public documentation site for Superset, built using [Docusaurus 2](https://docusaurus.io/). See [CONTRIBUTING.md](../CONTRIBUTING.md#documentation)` for documentation on contributing to documentation.