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 docs on building and hosting Docker images #640

Merged
merged 51 commits into from
Jun 12, 2024

Conversation

VJalili
Copy link
Member

@VJalili VJalili commented Feb 8, 2024

This PR simplifies the Docker-related documentation sections and updates Docusarus to its latest version. Specifically, it implements the following changes.

  • Make Docker-related docs more focused by simplifying and shortening the technical description and separating them from step-by-step walkthroughs;
  • Provide copy-paste commands to set up the environment and build docker images;
  • Simplify the Docker-related docks organization by removing the additional level of nesting in the Docker docs organization;
  • [x] Update the Docusarus version to its current latest, migrating its dependencies.
  • [x] Add more languages for code blocks for better syntax highlighting.

@VJalili VJalili marked this pull request as ready for review February 21, 2024 16:56
@VJalili VJalili requested a review from mwalker174 February 21, 2024 16:56
@VJalili VJalili force-pushed the docker_docs_docusaurus3 branch 2 times, most recently from 0bf68f8 to 78fe36e Compare June 11, 2024 19:50
VJalili added 2 commits June 11, 2024 15:53
…urus3

# Conflicts:
#	website/docs/gs/docker.md
#	website/docusaurus.config.js
#	website/package.json
@VJalili VJalili changed the title Update Docker docs & Docusaurus version to 3.1 Update docs on building and hosting Docker images Jun 11, 2024
@VJalili VJalili added the documentation Improvements or additions to documentation label Jun 11, 2024
Copy link
Collaborator

@mwalker174 mwalker174 left a comment

Choose a reason for hiding this comment

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

Thanks @VJalili I think a lot of users will find these guides very helpful! I have a lot of comments but they all minor suggestions.

website/docs/advanced/docker/automated.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/automated.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/automated.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/automated.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/automated.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/manual.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/manual.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/manual.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/manual.md Outdated Show resolved Hide resolved
website/docs/advanced/docker/manual.md Outdated Show resolved Hide resolved
VJalili and others added 27 commits June 12, 2024 09:46
@VJalili
Copy link
Member Author

VJalili commented Jun 12, 2024

Thank you @mwalker174! I updated the PR with your suggested changes.

@VJalili VJalili merged commit 944337e into broadinstitute:main Jun 12, 2024
3 checks passed
@VJalili VJalili deleted the docker_docs_docusaurus3 branch June 12, 2024 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants