Skip to content

Commit

Permalink
Merge branch 'apache:master' into cache_per_user
Browse files Browse the repository at this point in the history
  • Loading branch information
Samira-El authored Jun 17, 2022
2 parents 92498a5 + fa7f144 commit 01f0da1
Show file tree
Hide file tree
Showing 687 changed files with 9,280 additions and 4,075 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/welcome-new-users.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Welcome New Contributor

on:
pull_request_target:
types: [opened]

jobs:
welcome:
runs-on: ubuntu-latest
permissions:
issues: write

steps:
- name: Welcome Message
uses: actions/first-interaction@v1.0.0
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
pr-message: |-
Congrats on making your first PR and thank you for contributing to Superset! :tada: :heart:
We hope to see you in our [Slack](https://apache-superset.slack.com/) community too!
- name: First Time Label
uses: andymckay/labeler@master
with:
add-labels: "new:contributor"
repo-token: ${{ secrets.GITHUB_TOKEN }}
59 changes: 42 additions & 17 deletions CHANGELOG.md

Large diffs are not rendered by default.

34 changes: 21 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```

#### Build

To create and serve a production build of the documentation site:

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.
```shell
yarn build
yarn serve
```

#### Deployment

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.
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

Expand Down Expand Up @@ -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.

Expand Down
Loading

0 comments on commit 01f0da1

Please sign in to comment.