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

[Javadocs] add to o.o.action.admin #3155

Merged
merged 4 commits into from
May 4, 2022

Conversation

nknize
Copy link
Collaborator

@nknize nknize commented May 3, 2022

Adds javadocs to classes in package o.o.action.admin and removes unused classes. Also
adds custom javadoc tags opensearch.internal, opensearch.experimental, and opensearch.api

relates #221
relates #2868

@nknize nknize added documentation Improvements or additions to documentation non-issue bugs / unexpected behaviors that end up non issues; audit trail simple changes that aren't issues v3.0.0 Issues and PRs related to version 3.0.0 backport 2.x Backport to 2.x branch backport 2.0 Backport to 2.0 branch labels May 3, 2022
@nknize nknize requested review from a team and reta as code owners May 3, 2022 14:48
@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure f9da54ce4d55e49b16ee034e2039b5d030a227d3
Log 4934

Reports 4934

@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure 2733632ec048a1b8dfb39bcc70ad8a341295a31e
Log 4936

Reports 4936

@nknize nknize force-pushed the javadocs/server/action/admin branch from 2733632 to df8cc9c Compare May 3, 2022 16:19
@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure df8cc9cf34e4620c29c7ffbb25df4baa158cabfd
Log 4940

Reports 4940

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 2f93a2721e3e0510789f4ce0afdc979c4a91dd11
Log 4944

Reports 4944

@nknize nknize mentioned this pull request May 3, 2022
86 tasks
@@ -1,65 +0,0 @@
/*
Copy link
Collaborator

Choose a reason for hiding this comment

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

@nknize do you think we could move these changes to separate pull request (as you did with aliases & types)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure thing!

nknize added 4 commits May 3, 2022 14:53
Adds javadocs to classes in package o.o.action.admin and removes unused classes.

Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
@nknize nknize force-pushed the javadocs/server/action/admin branch from 2f93a27 to 0982d86 Compare May 3, 2022 19:59
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 0982d86
Log 4962

Reports 4962

@nknize nknize merged commit ad1c803 into opensearch-project:main May 4, 2022
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

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

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3155-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ad1c8038b01d6d82e5393d73bcbf28a43bb97bc2
# Push it to GitHub
git push --set-upstream origin backport/backport-3155-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

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

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.0 failed:

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

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.0 2.0
# Navigate to the new working tree
cd .worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-3155-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ad1c8038b01d6d82e5393d73bcbf28a43bb97bc2
# Push it to GitHub
git push --set-upstream origin backport/backport-3155-to-2.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.0

Then, create a pull request where the base branch is 2.0 and the compare/head branch is backport/backport-3155-to-2.0.

saratvemulapalli pushed a commit that referenced this pull request May 4, 2022
Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>
nknize added a commit to nknize/OpenSearch that referenced this pull request May 13, 2022
Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>
nknize added a commit that referenced this pull request May 13, 2022
Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>
nknize added a commit to nknize/OpenSearch that referenced this pull request May 13, 2022
Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>
nknize added a commit that referenced this pull request May 13, 2022
Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch backport 2.0 Backport to 2.0 branch documentation Improvements or additions to documentation non-issue bugs / unexpected behaviors that end up non issues; audit trail simple changes that aren't issues v3.0.0 Issues and PRs related to version 3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants