docs: reorganize the CONTRIBUTING section #28220
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Recently I realized that much of the content in CONTRIBUTING.md was duplicated in `docs/docs/contributing`, and had evloved into much of a complicated patchwork of semi-useful content. How I approached it: - decided to make CONTRIBUTING.md a simple pointer to the documentation website - merged all information into `docs/docs/contributing`, tried to take the more complete where docs had been copy/pasted - review the big sub-section into a more comprehensive set - Contibuting to Superset: high level info and orientation - Guidelines: how we approach guidelines, conventions, and interactions - Setting up a dev envrionemnt - Development how-tos - Resources: for things like ERD, arch diagrams, ... - Misc.: catch all for all the rest of things that don't fit anywhere - I re-did the top part of "Setting up a dev envrionemnt", as things were confusing and wanted to point more directly to docker-compose as the main supported method - various edits There's more work to be done here, but this seems much saner and much more manageable.
github-actions
bot
added
doc
|
This is great, having the docs as the only source of truth makes any future changes much more manageable IMO. |
|
@sfirke I was thinking the arch diagram you mentioned before will fit nicely under the "Resources" section along with the ERD that's in there now. |
sfirke
approved these changes
Apr 26, 2024
rusackas
approved these changes
Apr 26, 2024
Co-authored-by: Sam Firke <[email protected]>
Co-authored-by: Sam Firke <[email protected]>
Co-authored-by: Sam Firke <[email protected]>
qleroy
pushed a commit
to qleroy/superset
that referenced
this pull request
Apr 28, 2024
Co-authored-by: Sam Firke <[email protected]>
jzhao62
pushed a commit
to jzhao62/superset
that referenced
this pull request
May 16, 2024
Co-authored-by: Sam Firke <[email protected]>
vinothkumar66
pushed a commit
to vinothkumar66/superset
that referenced
this pull request
Nov 11, 2024
Co-authored-by: Sam Firke <[email protected]>
mistercrunch
added
🏷️ bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Recently I realized that much of the content in CONTRIBUTING.md was
duplicated in
docs/docs/contributing, and had evloved into much of acomplicated patchwork of semi-useful content.
How I approached it:
website
docs/docs/contributing, tried to takethe more complete where docs had been copy/pasted
were confusing and wanted to point more directly to docker-compose as
the main supported method
There's more work to be done here, but this seems much saner and much
more manageable.