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

Adding updated content to README.md and remove superfluous sections #596

Merged
merged 1 commit into from
Jul 23, 2021
Merged

Adding updated content to README.md and remove superfluous sections #596

merged 1 commit into from
Jul 23, 2021

Conversation

ahopp
Copy link
Contributor

@ahopp ahopp commented Jul 8, 2021 •
edited by tmarkley
Loading

Description

  • Add darkmode logo
  • Add a ToC and relevant sections
  • Add Project Resources to replace how can you help", "running tests", "guiding principles", etc.
  • Add CoC
  • Add License
  • Add Copyright

Issues Resolved

Partially Resolve: Issue #592

@ahopp ahopp changed the base branch from ahopp-patch-1 to main July 8, 2021 18:15
@opensearch-ci-bot
Copy link
Collaborator

❌   DCO Check Failed e39b78a
Run ./dev-tools/signoff-check.sh remotes/origin/main e39b78a140b819fcd19e9d62fb31b5920d7cf556 to check locally
Use git commit with -s to add 'Signed-of-by: {EMAIL}' on impacted commits

@ahopp ahopp changed the title Update README.md Adding updated content to README.md and remove superfluous sections Jul 8, 2021
@ahopp
Copy link
Contributor Author

ahopp commented Jul 8, 2021

Signed and added more descriptive title.

@kavilla
Copy link
Member

kavilla commented Jul 8, 2021

I see the PR title (although 50+ characters) and description was updated nicely,

but the actual commit (e39b78a) will need to be modified. which you can do in your terminal, command prompt, or git bash in the following way:

  • Get latest from main git pull main
  • Do an interactive rebase git rebase -i main
    You should see the following:
    Screen Shot 2021-07-08 at 12 27 45 PM
  • Tell git you want to reword the bad commit, so modify the rebase todo file to look like the following:
    Screen Shot 2021-07-08 at 12 29 41 PM
    Notice the change from 'pick' to 'r'
  • Save (write out) and exit the file
  • It should bring you back to the commit for rewording so now you can update the message, description, and sign it.
  • Save (write out) and exit the commit
  • git push -f

tmarkley
tmarkley reviewed Jul 9, 2021
View reviewed changes
README.md Outdated
@@ -1,78 +1,30 @@
# OpenSearch Dashboards
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we use the Dashboards logo?

@tmarkley
Copy link
Contributor

Need this to be deployed first to reference the Dashboards logo: opensearch-project/project-website#224

Also I looked into dynamically rendering the default/dark mode logo based on the GitHub theme but this doesn't seem supported yet: https://git.luolix.topmunity/t/support-theme-context-for-images-in-light-vs-dark-mode/147981/60

Clean up README.md
9772f18 
* Add darkmode logo
* Add a ToC and relevant sections
* Add Project Resources to replace how can you help", "running tests", "guiding principles", etc.
* Add CoC
* Add License
* Add Copyright

Signed-off-by: Tommy Markley <markleyt@amazon.com>
@tmarkley tmarkley requested review from boktorbb, kavilla and ananzh July 22, 2021 22:08
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 9772f18

mihirsoni
mihirsoni approved these changes Jul 23, 2021
View reviewed changes
Copy link
Contributor

@mihirsoni mihirsoni left a comment

Choose a reason for hiding this comment

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

LGTM !! Thanks for the changes.

@tmarkley
Copy link
Contributor

This for sure needs to go into v1.1, but should we push a patch v1.0.1 with this and other documentation changes included?

@tmarkley tmarkley merged commit f9b211c into main Jul 23, 2021
@tmarkley tmarkley deleted the ahopp-patch-2 branch July 23, 2021 17:36
tmarkley pushed a commit to tmarkley/OpenSearch-Dashboards that referenced this pull request Jul 23, 2021
@ahopp
Clean up README.md (opensearch-project#596)
6bc7895 
* Add darkmode logo
* Add a ToC and relevant sections
* Add Project Resources to replace how can you help", "running tests", "guiding principles", etc.
* Add CoC
* Add License
* Add Copyright

Signed-off-by: Tommy Markley <markleyt@amazon.com>

Co-authored-by: Andrew Hopp <andrew.hopp@me.com>
@tmarkley tmarkley mentioned this pull request Jul 23, 2021
Merged
1 task
tmarkley pushed a commit that referenced this pull request Jul 26, 2021
@ahopp
Clean up README.md (#596) (#662)
c93fc56 
* Add darkmode logo
* Add a ToC and relevant sections
* Add Project Resources to replace how can you help", "running tests", "guiding principles", etc.
* Add CoC
* Add License
* Add Copyright

Signed-off-by: Tommy Markley <markleyt@amazon.com>

Co-authored-by: Andrew Hopp <andrew.hopp@me.com>
@tmarkley tmarkley added the docs Improvements or additions to documentation label Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmarkley tmarkley tmarkley left review comments

@kavilla kavilla kavilla approved these changes

@mihirsoni mihirsoni mihirsoni approved these changes

@boktorbb boktorbb Awaiting requested review from boktorbb

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

Assignees
No one assigned
Labels
docs Improvements or additions to documentation v1.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ahopp @opensearch-ci-bot @kavilla @tmarkley @mihirsoni