Skip to content

[DOCS] Restructures repo README #7843

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

Merged
merged 1 commit into from
Jul 20, 2023
Merged

[DOCS] Restructures repo README #7843

merged 1 commit into from
Jul 20, 2023

Conversation

szabosteve
Copy link
Contributor

Overview

This PR adds links to the different sections of the README file that point to the corresponding section of the getting started page. This way only the getting started documentation needs to be maintained and it will be the source of truth.

Should be backported to 8.1.

Copy link
Member

@flobernd flobernd left a comment

Choose a reason for hiding this comment

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

LGTM!

@szabosteve szabosteve merged commit c60cdc5 into main Jul 20, 2023
@szabosteve szabosteve deleted the szabosteve/readme branch July 20, 2023 09:36
@github-actions
Copy link
Contributor

The backport to 8.1 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-8.1 8.1
# Navigate to the new working tree
cd .worktrees/backport-8.1
# Create a new branch
git switch --create backport-7843-to-8.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.1

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

@github-actions
Copy link
Contributor

The backport to 8.2 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-8.2 8.2
# Navigate to the new working tree
cd .worktrees/backport-8.2
# Create a new branch
git switch --create backport-7843-to-8.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.2

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

@github-actions
Copy link
Contributor

The backport to 8.3 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-8.3 8.3
# Navigate to the new working tree
cd .worktrees/backport-8.3
# Create a new branch
git switch --create backport-7843-to-8.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.3

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

@github-actions
Copy link
Contributor

The backport to 8.4 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-8.4 8.4
# Navigate to the new working tree
cd .worktrees/backport-8.4
# Create a new branch
git switch --create backport-7843-to-8.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.4

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

@github-actions
Copy link
Contributor

The backport to 8.5 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-8.5 8.5
# Navigate to the new working tree
cd .worktrees/backport-8.5
# Create a new branch
git switch --create backport-7843-to-8.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.5
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.5

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

@github-actions
Copy link
Contributor

The backport to 8.6 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-8.6 8.6
# Navigate to the new working tree
cd .worktrees/backport-8.6
# Create a new branch
git switch --create backport-7843-to-8.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.6
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.6

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

@github-actions
Copy link
Contributor

The backport to 8.7 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-8.7 8.7
# Navigate to the new working tree
cd .worktrees/backport-8.7
# Create a new branch
git switch --create backport-7843-to-8.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c60cdc56f69624013c26b2a3aea0a5a31be915ec
# Push it to GitHub
git push --set-upstream origin backport-7843-to-8.7
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.7

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

github-actions bot pushed a commit that referenced this pull request Jul 20, 2023
github-actions bot pushed a commit that referenced this pull request Jul 20, 2023
szabosteve added a commit that referenced this pull request Jul 20, 2023
szabosteve added a commit that referenced this pull request Jul 20, 2023
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.

2 participants