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

Update readme and more GitHub pages setup #869

Merged
merged 2 commits into from
Jul 10, 2023

Conversation

kolchfa-aws
Copy link
Contributor

Description

This PR:

  • Includes the contributing.md file to be built as a webpage
  • Adds the hosted documentation link to the readme
  • Adds favicon

Issues Resolved

N/A

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

@owaiskazi19
Copy link
Member

owaiskazi19 commented Jul 10, 2023

@kolchfa-aws can we have favicon.ico under assets?
I also think _includes and _layouts should be under assets at one place. We should not have new directories under root unless it define a new section of the code. This is mostly part of documentation website so can be pulled in one directory.

Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws
Copy link
Contributor Author

Moved favicon. I don't think I can move any of the other files as Jekyll expects them to be there in the root directory. There is an option to publish off of a dedicated branch though. We'll just have to make sure that any changes to documentation are automatically merged into that branch.

@saratvemulapalli saratvemulapalli merged commit a898727 into opensearch-project:main Jul 10, 2023
7 checks passed
@opensearch-trigger-bot
Copy link

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/opensearch-sdk-java/backport-1.x 1.x
# Navigate to the new working tree
pushd ../.worktrees/opensearch-sdk-java/backport-1.x
# Create a new branch
git switch --create backport/backport-869-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a89872744d2a653139f522b08e3ff1e0e8f78f4f
# Push it to GitHub
git push --set-upstream origin backport/backport-869-to-1.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/opensearch-sdk-java/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-869-to-1.x.

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

Successfully merging this pull request may close these issues.

3 participants