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

docs: BugHerd Tasks 88, 89, 90, 91 #25567

Merged
merged 13 commits into from
Oct 13, 2023
Merged

Conversation

mdeshmu
Copy link
Contributor

@mdeshmu mdeshmu commented Oct 8, 2023

SUMMARY

Address BugHerd Tasks
88 - Document #23745 (comment)
89 - Document AUTH_ROLES_MAPPING https://apache-superset.slack.com/archives/C0170U650CQ/p1696514613463559
90 - Document about SUPERSET_CONFIG_PATH variable
91 - Specifying correct python version in docs for official docker image

cc: @sfirke

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

@mdeshmu mdeshmu changed the title docs: Bugherd Tasks 89, 90, 91 docs: BugHerd Tasks 88, 89, 90, 91 Oct 9, 2023
@john-bodley
Copy link
Member

Thanks @mdeshmu for the change. Would you mind providing links to the Bugherd tasks and additionally include a synopsis of the task so that anyone without access to Bugherd can grok what the underlying issues being resolved are.

@mdeshmu
Copy link
Contributor Author

mdeshmu commented Oct 10, 2023

@john-bodley added links of the tasks and synopsis in the description

@mdeshmu
Copy link
Contributor Author

mdeshmu commented Oct 11, 2023

@sfirke @rusackas please review.

@sfirke
Copy link
Member

sfirke commented Oct 11, 2023

Thanks for flagging, I will review this.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

These are great additions! Content looks great, I just have some suggestions to make it read easier.

docs/docs/installation/configuring-superset.mdx Outdated Show resolved Hide resolved
docs/docs/installation/configuring-superset.mdx Outdated Show resolved Hide resolved
docs/docs/installation/configuring-superset.mdx Outdated Show resolved Hide resolved
docs/docs/installation/configuring-superset.mdx Outdated Show resolved Hide resolved
docs/docs/security/security.mdx Outdated Show resolved Hide resolved
docs/docs/security/security.mdx Outdated Show resolved Hide resolved
@sfirke
Copy link
Member

sfirke commented Oct 11, 2023

This are great additions @mdeshmu ! Only other thing: I noticed while reviewing this that the page title for https://superset.apache.org/docs/security/ is "Role based Access" - it should be "Security" probably. It's confusing to see that on the search engine results page. I'd also like to remove to the top heading that says "Roles", as that first summary paragraph should stand alone with no heading.

Are you up for making those fixes while you are editing this page?

@mdeshmu
Copy link
Contributor Author

mdeshmu commented Oct 11, 2023

@sfirke Those are great suggestions.
This is gonna improve my English comprehension a lot. :)

I will incorporate them soon.

mdeshmu and others added 11 commits October 12, 2023 06:25
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
@mdeshmu
Copy link
Contributor Author

mdeshmu commented Oct 12, 2023

@sfirke All requested changes are done. Please review.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

Thanks for making these edits! Especially to the page title for Security.

@sfirke sfirke merged commit 59fc5a6 into apache:master Oct 13, 2023
28 checks passed
@sfirke
Copy link
Member

sfirke commented Oct 13, 2023

Thanks @mdeshmu , this was a great addition!

@mdeshmu mdeshmu deleted the bugherd-89-90-91 branch October 13, 2023 15:25
cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.1.0 labels Mar 8, 2024
sfirke added a commit to sfirke/superset that referenced this pull request Mar 22, 2024
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
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/M 🚢 3.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants