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 Ubuntu build instructions #1651

Closed
mDuo13 opened this issue Dec 20, 2022 · 2 comments · Fixed by #1789
Closed

Update Ubuntu build instructions #1651

mDuo13 opened this issue Dec 20, 2022 · 2 comments · Fixed by #1789
Assignees
Labels
content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts infra Server configuration, validation, infrastructure, peer-to-peer network details

Comments

@mDuo13
Copy link
Collaborator

mDuo13 commented Dec 20, 2022

Just recently the steps needed to build rippled on Ubuntu changed (starting with dev versions of 1.10.0) to use Conan to manage packages. This means changes to the build instructions.

Upstream PR: XRPLF/rippled#4367
Related: #1650, #1648.

Add any new dependencies and modify the steps as necessary to build on supported (current) versions of Ubuntu.

Aside: future of build instructions

It has been previously discussed, and might still be a good idea, to remove the separate build instructions on the xrpl website and only link the instructions in the source repo, since the method of building is specific to the release version. The repo also has build instructions for more platforms. We would like to first make sure the build instructions in the repo are clear and easy enough to follow, though, which might mean making PRs against the rippled repo to update them there.

There's also the consideration that the website has Japanese-translated build instructions, which aren't kept perfectly up-to-date with the English but are probably better than nothing for native Japanese speakers; so we might want to port those to the upstream repo as well, but the team may not want to be responsible for those since they it would probably require someone fluent in Japanese to keep things updated as well.

@mDuo13 mDuo13 added content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts infra Server configuration, validation, infrastructure, peer-to-peer network details labels Dec 20, 2022
@thejohnfreeman
Copy link
Contributor

I prefer to link to the new build instructions in the root directory of the project, in the conventionally named file BUILD.md.

I would like to collaborate on fixing up the build instructions in the repository:

  • I believe that, under the directory Builds/, the directories VisualStudio2019, linux, and macos can be removed. In fact, I believe they contain currently incorrect documentation, on top of being elaborate and confusing. I suspect that Test.py and build_all.sh are unused and can be removed.
  • We should move and update documentation on the project options from Builds/linux/README.md to BUILD.md.
  • I'd like a review from technical writers on the structure of BUILD.md. We're trying to serve a few different audiences:
    • Maintainers who are responsible for keeping these instructions up-to-date. It's better to have them all in one file, instead of just-slightly-different-but-mostly-identical instructions in separate files and directories for each platform.
    • Experienced developers who just need to reference the commands, and maybe copy them.
    • New developers who need a walk through, including an introduction to Conan and CMake.

I think it's totally fine to add a Japanese translation to the source repo. Perhaps we can add a note at the top to warn readers to check the difference between the last time the English and Japanese versions were changed.

@intelliot
Copy link
Contributor

I recommend deleting what's on xrpl.org (as it's out of date / obsolete anyway) and pointing people to instructions in rippled repo.

@oeggert oeggert self-assigned this Jan 26, 2023
@oeggert oeggert moved this to In Progress in XRPL Docs Jan 26, 2023
@oeggert oeggert moved this from In Progress to Planned in XRPL Docs Jan 27, 2023
@mDuo13 mDuo13 removed their assignment Jan 28, 2023
@oeggert oeggert moved this from Planned to In Progress in XRPL Docs Feb 9, 2023
@oeggert oeggert moved this from In Progress to In Review in XRPL Docs Feb 14, 2023
@oeggert oeggert moved this from In Review to In Progress in XRPL Docs Mar 6, 2023
@oeggert oeggert closed this as completed Mar 8, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in XRPL Docs Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts infra Server configuration, validation, infrastructure, peer-to-peer network details
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants