Rewrite Contributing and readme #4416

kolchfa-aws · 2023-06-28T20:38:08Z

Description

Rewrite Contributing and readme

Issues Resolved

Fixes #64

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter

Thanks, Fanit! I have some questions about the flow of info on the contributions page.

CONTRIBUTING.md

Signed-off-by: Fanit Kolchina <[email protected]>

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

…t/documentation-website into update-readmes

hdhalter

A few comments. Thanks!

CONTRIBUTING.md

hdhalter · 2023-06-29T18:44:41Z

CONTRIBUTING.md


-If you’d like to make a change directly to the content, create a pull request. If it’s a quick fix, we should be able to release the update quickly. Bigger requests might take a bit of time for us to review. 
+- Make your changes
+- Build locally to check your work (only possible if you are making changes locally)


Suggested change

- Build locally to check your work (only possible if you are making changes locally)

- Build a local instance of the content to check your work (only possible if you are editing the files locally)

CONTRIBUTING.md

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter

Looks good, just a couple of minor suggestions.

CONTRIBUTING.md

hdhalter · 2023-06-29T19:54:02Z

README.md

- Markdown is easy to learn and looks good in side-by-side diffs.
- The workflow is no different than contributing code. Make your changes, build locally to check your work, and submit a pull request. Reviewers check the PR before merging.
- Alternatives like wikis and WordPress are full web applications that require databases and ongoing maintenance. They also have inferior versioning and content review processes compared to Git. Static websites, such as the ones Jekyll produces, are faster, more secure, and more stable.
+This repository contains [Markdown](https://guides.github.com/features/mastering-markdown/) files organized into Jekyll _collections_ (for example, `_api-reference` or `_dashboards`). Each Markdown file corresponds to one page on the website.


Do we need this section here? Would it be more appropriate in the contribution file?

The readme is the what and the contributing is the how in my opinion. So readme is about this repo and contributing is about how to contribute. So I think it's better to have it here.

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Heather Halter <[email protected]>

…uting Signed-off-by: Fanit Kolchina <[email protected]>

CONTRIBUTING.md

hdhalter

Just a few tweaks, but otherwise, looks good!

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Naarcha-AWS · 2023-06-30T15:20:49Z

CONTRIBUTING.md


-Before entering a change request, please read this document carefully. We want to make sure we have all the information necessary to effectively respond to your contribution. 
+NOTE: If you’d like to contribute but don't know where to start, try browsing existing [issues](https://github.com/opensearch-project/documentation-website/issues). Our projects use custom GitHub issue labels for status, version, type of request, and so on, but we recommend looking at any issues labeled `good first issue` first. 


Should we mention the help wanted label as well?

CONTRIBUTING.md

Naarcha-AWS · 2023-06-30T15:22:41Z

CONTRIBUTING.md


-If you’d like to contribute but don't know where to start, try browsing existing issues. Our projects use custom GitHub issue labels for status, version, type of request, etc., but we recommend looking at any issues labeled “good first issue” first. 
+1. In the upper-right corner, select the dropdown with the pencil icon and select **Edit in place**. Edit the file.


Why do they have to use the "Edit in place" option? They can also just select the pencil icon, which defaults to editing through GitHub automatically?

CONTRIBUTING.md

Naarcha-AWS · 2023-06-30T15:26:56Z

CONTRIBUTING.md

+
+1. Edit the Markdown files that you want to change.
+
+1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10 to 30 seconds.


The build takes longer on most machines now.

Suggested change

1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10 to 30 seconds.

1. When you save a file, Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 60 - 90 seconds.

CONTRIBUTING.md

README.md

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

…t/documentation-website into update-readmes

Signed-off-by: Fanit Kolchina <[email protected]>

natebower

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

CONTRIBUTING.md

README.md

natebower · 2023-07-05T14:14:37Z

README.md

 ## Code of conduct

 This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html).


 ## Security

-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.


Suggested change

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.

If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.

natebower · 2023-07-05T14:16:46Z

README.md

 ## Code of conduct

 This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html).


 ## Security

-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.


Re: "AWS/Amazon Security": Which one? Also, if he hasn't already, I would consider having Weston review this statement, especially given that we don't appear to provide a "why" in relation to the last sentence.

This was also taken from the main OpenSearch repo.

Let's just have Weston take a quick look to ensure he's OK with it.

README.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

CONTRIBUTING.md

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

* Rewrite Contributing and readme Signed-off-by: Fanit Kolchina <[email protected]> * Changes to the structure Signed-off-by: Fanit Kolchina <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Reordered sections Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Doc review changes Signed-off-by: Fanit Kolchina <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * added list of resources Signed-off-by: Heather Halter <[email protected]> * Moved front matter section to formatting guide and linting to contributing Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Add doc review comments Signed-off-by: Fanit Kolchina <[email protected]> * Delete word Signed-off-by: Fanit Kolchina <[email protected]> * Minor rewording Signed-off-by: Fanit Kolchina <[email protected]> * Change link Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Rewrite Contributing and readme

714d270

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws requested review from cwillum, hdhalter, Naarcha-AWS, vagimeli, ananzh, seanneumann, AMoo-Miki and natebower as code owners June 28, 2023 20:38

kolchfa-aws self-assigned this Jun 28, 2023

hdhalter reviewed Jun 28, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

kolchfa-aws and others added 4 commits June 28, 2023 22:00

Changes to the structure

b878946

Signed-off-by: Fanit Kolchina <[email protected]>

Update CONTRIBUTING.md

2f5ef09

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Reordered sections

93e3544

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'update-readmes' of https://github.com/opensearch-projec…

11bea08

…t/documentation-website into update-readmes

hdhalter reviewed Jun 29, 2023

View reviewed changes

kolchfa-aws and others added 2 commits June 29, 2023 15:02

Apply suggestions from code review

e258bf2

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Doc review changes

59b10f3

Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter reviewed Jun 29, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

hdhalter reviewed Jun 29, 2023

View reviewed changes

kolchfa-aws and others added 4 commits June 29, 2023 16:24

Update CONTRIBUTING.md

25a173f

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Update CONTRIBUTING.md

ef011ed

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

added list of resources

ab6e251

Signed-off-by: Heather Halter <[email protected]>

Moved front matter section to formatting guide and linting to contrib…

1741446

…uting Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter reviewed Jun 29, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

hdhalter approved these changes Jun 29, 2023

View reviewed changes

Apply suggestions from code review

787188f

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Naarcha-AWS reviewed Jun 30, 2023

View reviewed changes

kolchfa-aws and others added 2 commits June 30, 2023 12:13

Apply suggestions from code review

c7cd5ad

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Add doc review comments

47205fc

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws added 4 commits June 30, 2023 12:21

Delete word

8059138

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'update-readmes' of https://github.com/opensearch-projec…

7830ab6

…t/documentation-website into update-readmes

Minor rewording

cfbb73d

Signed-off-by: Fanit Kolchina <[email protected]>

Change link

9281a31

Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter added the 5 - Editorial review PR: Editorial review in progress label Jul 3, 2023

natebower reviewed Jul 5, 2023

View reviewed changes

kolchfa-aws and others added 2 commits July 5, 2023 10:35

Apply suggestions from code review

e4c2cc5

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Implemented editorial comments

2e98c2a

Signed-off-by: Fanit Kolchina <[email protected]>

hdhalter reviewed Jul 6, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

hdhalter mentioned this pull request Jul 6, 2023

[DOC] Project readme incorrect #4498

Closed

4 tasks

Update CONTRIBUTING.md

0ede051

Co-authored-by: Heather Halter <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

kolchfa-aws merged commit 5f8ddb8 into main Jul 19, 2023

hdhalter deleted the update-readmes branch March 28, 2024 21:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite Contributing and readme #4416

Rewrite Contributing and readme #4416

kolchfa-aws commented Jun 28, 2023

hdhalter left a comment

hdhalter left a comment

hdhalter Jun 29, 2023

kolchfa-aws Jun 29, 2023

hdhalter left a comment

hdhalter Jun 29, 2023

kolchfa-aws Jun 29, 2023

hdhalter left a comment

Naarcha-AWS Jun 30, 2023

Naarcha-AWS Jun 30, 2023

Naarcha-AWS Jun 30, 2023

natebower left a comment

natebower Jul 5, 2023

natebower Jul 5, 2023

kolchfa-aws Jul 5, 2023

natebower Jul 5, 2023

	- Build locally to check your work (only possible if you are making changes locally)
	- Build a local instance of the content to check your work (only possible if you are editing the files locally)


		Before entering a change request, please read this document carefully. We want to make sure we have all the information necessary to effectively respond to your contribution.
		NOTE: If you’d like to contribute but don't know where to start, try browsing existing [issues](https://github.com/opensearch-project/documentation-website/issues). Our projects use custom GitHub issue labels for status, version, type of request, and so on, but we recommend looking at any issues labeled `good first issue` first.


		If you’d like to contribute but don't know where to start, try browsing existing issues. Our projects use custom GitHub issue labels for status, version, type of request, etc., but we recommend looking at any issues labeled “good first issue” first.
		1. In the upper-right corner, select the dropdown with the pencil icon and select Edit in place. Edit the file.


		1. Edit the Markdown files that you want to change.

		1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10 to 30 seconds.

	1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10 to 30 seconds.
	1. When you save a file, Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 60 - 90 seconds.

	If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do not create a public GitHub issue.
	If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do not create a public GitHub issue.

Rewrite Contributing and readme #4416

Rewrite Contributing and readme #4416

Conversation

kolchfa-aws commented Jun 28, 2023

Description

Issues Resolved

Checklist

hdhalter left a comment

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdhalter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment