Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix 'npm run build' + run 'npm audit fix' #10995

Closed
wants to merge 4 commits into from
Closed

docs: fix 'npm run build' + run 'npm audit fix' #10995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bad81d9
docs: fix 'npm run build' + run 'npm audit fix'
mistercrunch Sep 22, 2020
889d11e
adding some instrucitons to README
mistercrunch Sep 22, 2020
0164348
tweaking the rat
mistercrunch Sep 22, 2020
ca0781c
RATs
mistercrunch Sep 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .rat-excludes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Note: these patterns are applied to single files or directories, not full paths
docs/README.md
.gitignore
.gitattributes
.gitkeep
Expand Down Expand Up @@ -33,7 +34,7 @@ apache_superset.egg-info
.*csv
# Generated doc files
env/*
docs/README.md
docs/README*
docs/.htaccess*
_build/*
_static/*
Expand Down
30 changes: 11 additions & 19 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
<!--
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

http://www.apache.org/licenses/LICENSE-2.0

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

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

Expand Down Expand Up @@ -65,3 +46,14 @@ git push origin asf-site

# SUCCESS - it should take minutes to take effect on superset.apache.org
```

## Contributing Screenshots to the Gallery

We welcome the addition of screenshots to our gallery. All you have to do is
to drop high
resolution images (ideally retina quality)
[here](https://github.com/apache/incubator-superset/tree/master/docs/src/images/gallery)
and Gatsby does all the work of creating thumbnails for the
[gallery](https://superset.apache.org/gallery/) at build time.
Ordering, captions and tags can be defined
[in this file](https://github.com/apache/incubator-superset/blob/master/docs/src/pages/gallery.tsx#L41).
Loading