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

docs: setting up dev containers #53

Merged

Conversation

ThEditor
Copy link

Summary

  • Enabled sphinx.ext.autosectionlabel to link sections
  • Mentioned the two ways of dev environment setup - host, devcontainers.
  • Created a guide on setting up devcontainers

Reviewer guidance

Build the docs using make docs and open localhost:8888 to check the updated documentation.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@vkWeb
Copy link
Owner

vkWeb commented Dec 23, 2023

@ThEditor this is marked as draft, is it ready for review or you are gonna be making more changes?

@ThEditor
Copy link
Author

Woops, forgot to mark it ready for review.

@ThEditor ThEditor marked this pull request as ready for review December 23, 2023 16:24
@vkWeb vkWeb merged commit 22b1c09 into vkWeb:docker-developer-revamp Dec 26, 2023
10 checks passed
@vkWeb
Copy link
Owner

vkWeb commented Dec 26, 2023

I appreciate your thought process about keeping the old docker instructions and marking it as legacy. Overall nice work.

I'll make further edits on top of your documentation and I will soon let you know about the final product.

@ThEditor merged your PR, thanks man!

@vkWeb
Copy link
Owner

vkWeb commented Dec 27, 2023

I have edits on top of your docs here -- learningequality#11443.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants