pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation on updating documentation. (#20400)

This commit is contained in:
Cody Leff 2022-06-16 15:05:37 -06:00 committed by GitHub
parent a8a6b732e9
commit fadf0ec5ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -160,7 +160,7 @@ Look through the GitHub issues. Issues tagged with
Superset could always use better documentation,
whether as part of the official Superset docs,
in docstrings, `docs/*.rst` or even on the web as blog posts or
in docstrings, or even on the web as blog posts or
articles. See [Documentation](#documentation) for more details.
### Add Translations
@ -388,23 +388,30 @@ cd superset
The latest documentation and tutorial are available at https://superset.apache.org/.
The site is written using the Gatsby framework and docz for the
documentation subsection. Find out more about it in `docs/README.md`
The documentation site is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator, the source for which resides in `./docs`.
#### Images
#### Local Development
If you're adding new images to the documentation, you'll notice that the images
referenced in the rst, e.g.
To set up a local development environment with hot reloading for the documentation site:
.. image:: _static/images/tutorial/tutorial_01_sources_database.png
```shell
cd docs
yarn install # Installs NPM dependencies
yarn start # Starts development server at http://localhost:3000
```
aren't actually stored in that directory. Instead, you should add and commit
images (and any other static assets) to the `superset-frontend/src/assets/images` directory.
When the docs are deployed to https://superset.apache.org/, images
are copied from there to the `_static/images` directory, just like they're referenced
in the docs.
#### Build
For example, the image referenced above actually lives in `superset-frontend/src/assets/images/tutorial`. Since the image is moved during the documentation build process, the docs reference the image in `_static/images/tutorial` instead.
To create and serve a production build of the documentation site:
```shell
yarn build
yarn serve
```
#### Deployment
Commits to `master` trigger a rebuild and redeploy of the documentation site. Submit pull requests that modify the documention with the `docs:` prefix.
### Flask server
@ -1064,6 +1071,7 @@ LANGUAGES = {
```
This script will
1. update the template file `superset/translations/messages.pot` with current application strings.
2. update language files with the new extracted strings.

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.