[docs] Add tldr section for coredb contributors #22172
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for infallible-bardeen-164bc9 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
The text following the large header "TLDR" gets rendered larger than usual. Try to add extra empty lines to perhaps avoid that.
It doesn't work. Oh well. This reverts commit 81ef903.
aishwarya24
reviewed
Apr 29, 2024
aishwarya24
approved these changes
Apr 29, 2024
mbautin
approved these changes
Apr 30, 2024
| rsync | ||
| ) | ||
| sudo dnf -y install "${packages[@]}" | ||
| sudo alternatives --set python3 /usr/bin/python3.9 |
There was a problem hiding this comment.
Some systems may use Python 3.10 or 3.11. Can we remove the hard-coded 3.9?
There was a problem hiding this comment.
There is no python310 or python311 package yet on Almalinux 8 as far as I can tell. Also, this is based off of the python section below, so changing both copies of this could be considered out of scope of this PR.
| sudo alternatives --set python3 /usr/bin/python3.9 | ||
| latest_zip_url=$(curl -Ls "https://api.github.com/repos/ninja-build/ninja/releases/latest" \ | ||
| | grep browser_download_url | grep ninja-linux.zip | cut -d \" -f 4) | ||
| curl -Ls "$latest_zip_url" | zcat | sudo tee /usr/local/bin/ninja >/dev/null |
There was a problem hiding this comment.
Instead of piping output to /dev/null, maybe pass the -s / --silent option to curl?
There was a problem hiding this comment.
-s is used. sudo tee is piping to /dev/null
| git clone https://github.com/yugabyte/yugabyte-db | ||
| cd yugabyte-db | ||
| case "$VERSION_ID" in | ||
| 20.04) |
There was a problem hiding this comment.
Do we really need support for building on Ubuntu 20.04?
There was a problem hiding this comment.
no point in removing it yet
ddhodge
reviewed
May 4, 2024
docs/content/preview/contribute/core-database/build-from-src-almalinux.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-almalinux.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-almalinux.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-centos.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-centos.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-centos.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-ubuntu.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-ubuntu.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-ubuntu.md
Outdated
Show resolved
Hide resolved
docs/content/preview/contribute/core-database/build-from-src-almalinux.md
Outdated
Show resolved
Hide resolved
According to Dwight: > In page headings start at level 2, that's what the styles support - bump all the headings down a level, or I provided an alternative Apply the review comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CoreDB contributor docs for compiling have separate pieces of
instructions with some beneficial commentary, but there is no fast way
to do it in one shot.
Add a tldr section for all the linux platforms that collects all the
separate instructions into one place. This means future edits to the
instructions may need to worry about keeping the two in sync, but the
convenience seems worth it. Tested using docker images centos:7,
ubuntu:20.04, ubuntu:22.04, almalinux/8-minimal. It would be nice to
create docker files using those images as a followup.