Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
20 changes: 0 additions & 20 deletions docs-v2/.gitignore

This file was deleted.

5 changes: 0 additions & 5 deletions docs-v2/.prettierrc

This file was deleted.

33 changes: 0 additions & 33 deletions docs-v2/README.md

This file was deleted.

9,797 changes: 0 additions & 9,797 deletions docs-v2/package-lock.json

This file was deleted.

49 changes: 0 additions & 49 deletions docs-v2/package.json

This file was deleted.

41 changes: 0 additions & 41 deletions docs-v2/src/pages/index.tsx

This file was deleted.

22 changes: 0 additions & 22 deletions docs/.asf.yaml

This file was deleted.

48 changes: 0 additions & 48 deletions docs/.eslintrc.js

This file was deleted.

23 changes: 20 additions & 3 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
.docz
.cache
public
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
23 changes: 0 additions & 23 deletions docs/.htaccess

This file was deleted.

1 change: 0 additions & 1 deletion docs/.nvmrc

This file was deleted.

76 changes: 20 additions & 56 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,33 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
# Website

http://www.apache.org/licenses/LICENSE-2.0
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
### Installation

Here's the source to the documentation hosted at
<a href="https://superset.apache.org">superset.apache.org</a>

The site runs on the Gatsby framework and uses docz for it's
`Documentation` subsection.

## Getting Started

```bash
cd docs/
npm install
npm run start
# navigate to localhost:8000`
```
$ yarn
```

## To Publish

Github Actions CI automatically publishes the site after changes are
merged to master.
### Local Development

To manually publish, the static site that Gatsby generates needs to be pushed
to the `asf-site` branch on the
[apache/superset-site](https://github.com/apache/superset-site/)
repository. No need to PR here, simply `git push`.
```
$ yarn start
```

```bash
# Get in the docs/ folder in the main repo
cd ~/repos/superset/docs
# have Gatsby build the static website, this puts in under `docs/public`
npm run build
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

# go to the docs repo
cd ~/repos/superset-site
# checkout the proper branch
git checkout asf-site
### Build

# BE CAREFUL WITH THIS COMMAND
# wipe the content of the repo
rm -rf *
```
$ yarn build
```

# copy the static site here
cp -r ~/repos/superset/docs/public/ ./
This command generates static content into the `build` directory and can be served using any static contents hosting service.

# git push
git add .
git commit -m "relevant commit msg"
git push origin asf-site
### Deployment

# SUCCESS - it should take minutes to take effect on superset.apache.org
```
$ 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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading