Skip to content

consolidate markdown documentation#743

Merged
nonsense merged 9 commits intomainfrom
nonsense/consolidate-README.md-docs
Aug 31, 2022
Merged

consolidate markdown documentation#743
nonsense merged 9 commits intomainfrom
nonsense/consolidate-README.md-docs

Conversation

@nonsense
Copy link
Copy Markdown
Member

@nonsense nonsense commented Aug 30, 2022

This PR is consolidating all README.md files in Boost into one main README.md

I've also removed some instructions that are duplicates across the various README.md

I've also moved /build/devnet into /docker/devnet as I don't think these Dockerfiles belong to /build.

@nonsense nonsense requested a review from LexLuthr August 30, 2022 14:59
@nonsense nonsense marked this pull request as ready for review August 30, 2022 15:44
@nonsense nonsense mentioned this pull request Aug 30, 2022
10 tasks

## Running Boost devnet in Docker

### Building Docker images
Copy link
Copy Markdown
Contributor

@airenas airenas Aug 31, 2022

Choose a reason for hiding this comment

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

In the future, I would suggest pushing images to dockerhub and skipping this step for new users to start quickly without the building step.

And now I would suggest just cd docker && make build/all. Because if a user changes versions for the build step then versions need to be changed also in docker compose .env.

I was writing building instructions for the advanced boost developer who wants to push images

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

In the future, I would suggest pushing images to dockerhub and skipping this step for new users to start quickly without the building step.

Agree, but I am not sure we should document the pushing here really... Pushing of images is going to happen within the team, by whoever has access to the Docker Registry.


We should make sure we have support to build Boost from source, because most developers on the team would be running a dev version of the Boost image, and sometimes even of Lotus images.

@nonsense nonsense merged commit 42fb5c0 into main Aug 31, 2022
@nonsense nonsense deleted the nonsense/consolidate-README.md-docs branch October 17, 2022 09:56
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