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

Containerize process for local development setup #8220

Merged

Conversation

hainenber
Copy link
Contributor

Description

Describe what this change achieves.
Containerize process for local development setup to facilitate contributing effort.

Issues Resolved

Closes #[insert issue number]
N/A

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
N/A

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
N/A

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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

CONTRIBUTING.md Outdated
@@ -76,7 +76,9 @@ Follow these steps to set up your local copy of the repository:

1. [Fork this repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone your fork.

1. Navigate to your cloned repository.
2. Navigate to your cloned repository.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please leave the 1. numbering. Jekyll automatically translates these into numbered lists. And it's easier to reorder/add/delete items this way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted :D

@kolchfa-aws
Copy link
Collaborator

We have a similar PR #7273 @epugh Could you review/reconcile these two PRs? I think there's a lot of added value in documenting how to run the site via Docker.

@kolchfa-aws
Copy link
Collaborator

Hey @epugh, can you help review and reconcile this PR?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
hainenber and others added 2 commits September 26, 2024 23:18
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Đỗ Trọng Hải <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Đỗ Trọng Hải <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

@hainenber Tested locally to ensure this works. This should greatly simplify contributing, thanks so much!

@kolchfa-aws kolchfa-aws merged commit 6c5c04c into opensearch-project:main Sep 26, 2024
6 checks passed
@hainenber
Copy link
Contributor Author

Yes, this is tested locally :D
I should have brought these visuals into the PR's description though.

The browser
image

The console
image

@hainenber hainenber deleted the containerize-doc-building branch September 26, 2024 16:30
@kolchfa-aws
Copy link
Collaborator

I meant I have tested locally 😄 to verify it works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants