You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2021/12/10 17:11:53 UTC
[GitHub] [superset] corbinrobb opened a new pull request #17714: chore(docsV2): move content from docs to docsV2
corbinrobb opened a new pull request #17714:
URL: https://github.com/apache/superset/pull/17714
### SUMMARY
Mostly just copy-pasting contents of markdown files from docs to docsV2.
Pages:
- Frequently Asked Questions
- Contribution Guide
- Roadmap
- API
- Security
### NOTEWORTHY
---
### Frontmatter
I removed some variables from the markdown pages frontmatter because Docusaurus doesn't need or use it
Ex in v1 docs/frequently-asked-questions:
```
---
name: Frequently Asked Questions
title: Frequently Asked Questions
route: /docs/frequently-asked-questions
---
```
name:
- Docusaurus doesn't mention this variable and I couldn't find it used anywhere
route:
- Docusaurus will set the route to be the file name by default and doesn't use this variable to change that
- If we want the route to be different than the file name we would use `id: different-name` or `slug: /different/path/to/file`
I also added some variables to better match the v1 docs
Ex in v2 docs/frequently-asked-questions:
```
---
title: Frequently Asked Questions
hide_title: true
sidebar_position: 6
---
```
title/hide_title:
- Docusaurus uses the title variable to set the content of the tab title in the sidebar and the title in the HTML head metadata
- If you don't have a `# Level 1 header` on the page it will add one to the top of the page with the title as its content
- v1 docs use `## Level 2 header` for its headers and the size of the `# Level 1 header` is a lot bigger so `hide_title: true` will tell Docusaurus not to add the level 1 header.
sidebar_position:
- Used to specify its tab position in the sidebar
---
---
### API page using SwaggerUI and Antd Design
`/docs/api.mdx`
SwaggerUI:
- Needs the `swagger-ui-react` dependency and that needs the `buffer` and `stream` dependencies. So I added them with `yarn add`
- The `buffer` needs to be declared and added using `import { Buffer } from "buffer"; global.Buffer = Buffer;` So I added that to the file. It is global so it could be added to the topmost file but since it is only relevant to this file I felt it made sense.
- Docusaurus styles clashed with some of SwaggerUIs so I added some CSS to `css/custom.css` to fix it and make it look like the v1 docs
- I also pulled over some CSS styles from v1 docs that hide the authorization and "try it out" mode.
- Added a `TODO:` to fix the styling issues that SwaggerUI has with Docusauruses dark mode. It seems the SwaggerUI styles are more specific than the dark mode ones so we might need to hunt them all down and create more specific styling. I can add a ticket to the board for this.
- SwaggerUI needed the `openapi.json` superset data so I copied that over and added it to `static/resources/openapi.json`. This seemed to be the appropriate place and since it was in a resources folder in v1 docs I did the same here.
New dependencies and their version numbers for reference
```
"swagger-ui-react": "^4.1.2",
"buffer": "^6.0.3",
"stream": "^0.0.2",
```
Antd Design:
The v1 docs have the `antd` dependency and it's mostly used for creating the layout except for this `Alert` component on the API page. I wasn't sure if we will be using Antd because there is already a layout and since this is the only place in the markdown content that I could find one used, I decided to hold off on adding the dependency and comment out the component and the import until I know if we want to add it.
The Alert component styles were simple so copied them and added a class to style a div to look the same as it does on the v1 docs.
I did add Antd locally and its CSS styles wreck most of the Docusaurus dark mode styles. This also influenced my decision to hold off on adding the dependency because I think the dark mode is pretty cool.
---
---
Issue linking for Linear:
completes SUP-29, SUP-30, SUP-31, SUP-32 and SUP-33
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A
### TESTING INSTRUCTIONS
Open the docsV2 site and click through the sidebar pages for:
- Frequently Asked Questions
- Contribution Guide
- Roadmap
- API
- Security
Compare to current Superset documentation site
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] AAfghahi removed a comment on pull request #17714: chore(docsV2): move content from docs to docsV2
Posted by GitBox <gi...@apache.org>.
AAfghahi removed a comment on pull request #17714:
URL: https://github.com/apache/superset/pull/17714#issuecomment-992607428
Hey LGTM! Let me know when you add in the Apache Licensing on the top of the pages and they go green :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] hughhhh commented on pull request #17714: chore(docsV2): move content from docs to docsV2
Posted by GitBox <gi...@apache.org>.
hughhhh commented on pull request #17714:
URL: https://github.com/apache/superset/pull/17714#issuecomment-992664624
We just need to update the `rat-access` files for the license check to work. So going to merge this in for now and once we goto master things will play nice since it will be under the docs directory.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] corbinrobb commented on pull request #17714: chore(docsV2): move content from docs to docsV2
Posted by GitBox <gi...@apache.org>.
corbinrobb commented on pull request #17714:
URL: https://github.com/apache/superset/pull/17714#issuecomment-991149034
@hughhhh
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] hughhhh merged pull request #17714: chore(docsV2): move content from docs to docsV2
Posted by GitBox <gi...@apache.org>.
hughhhh merged pull request #17714:
URL: https://github.com/apache/superset/pull/17714
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] AAfghahi commented on pull request #17714: chore(docsV2): move content from docs to docsV2
Posted by GitBox <gi...@apache.org>.
AAfghahi commented on pull request #17714:
URL: https://github.com/apache/superset/pull/17714#issuecomment-992607428
Hey LGTM! Let me know when you add in the Apache Licensing on the top of the pages and they go green :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org