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.

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

fix(docs): Installation instruction changes #23867

Merged
merged 21 commits into from
May 17, 2023
Merged

fix(docs): Installation instruction changes #23867

merged 21 commits into from
May 17, 2023

Conversation

artofcomputing
Copy link
Contributor

SUMMARY

Updating installation instructions to contain up to date information of Superset's SECRET_KEY variable for production usage.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • 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

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@sfirke
Copy link
Member

sfirke commented May 1, 2023

To the reviewer(s): all of the sidebar_position changes are to move the "Running with Kubernetes" page up to its logical place, position 3. All the other pages needed to get shuffled down.

@artofcomputing artofcomputing changed the title docs: Installation instruction changes fix(docs): Installation instruction changes May 1, 2023
@artofcomputing
Copy link
Contributor Author

After this PR, we can change the configuration of the sidebar in docs/sidebars.js so that we don't depend on each document metadata to define their position, making the documents much easier to work with.

However we might need to document that change, so other contributors can add their pages in the file instead of defining metadata fields.

Copy link
Contributor Author

@artofcomputing artofcomputing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the changes were done to fix small grammar issues and to inform users that new Superset versions require the SECRET_KEY environment variable to be set when deploying to production.

@sfirke
Copy link
Member

sfirke commented May 16, 2023

I believe this PR makes another open one obsolete: #20482

@rusackas
Copy link
Member

Closing/reopening to kick-start CI.

@rusackas rusackas closed this May 16, 2023
@rusackas rusackas reopened this May 16, 2023
@rusackas rusackas merged commit de2d7af into apache:master May 17, 2023
57 checks passed
@rusackas rusackas mentioned this pull request May 17, 2023
9 tasks
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.0.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/L 🚢 3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants