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: refresh documentation for running without a devcontainer #956

Merged
merged 9 commits into from
May 24, 2024

Conversation

liammoat
Copy link
Collaborator

Purpose

This pull request includes changes to the local setup documentation, specifically for macOS developers and those not using a DevContainer. The most significant changes include the addition of a note for macOS developers in the LOCAL_DEPLOYMENT.md file, and a rewrite of the NON_DEVCONTAINER_SETUP.md file to make it more detailed and user-friendly.

Does this introduce a breaking change?

  • Yes
  • No

Co-authored-by: Arpit Gaur <gaurarpit@gmail.com>
@liammoat liammoat linked an issue May 21, 2024 that may be closed by this pull request
Copy link

github-actions bot commented May 21, 2024

Coverage

Coverage Report •
FileStmtsMissCoverMissing
TOTAL250056177% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
277 0 💤 0 ❌ 0 🔥 34.697s ⏱️

@gaurarpit gaurarpit marked this pull request as ready for review May 22, 2024 12:49
@gaurarpit gaurarpit enabled auto-merge May 22, 2024 13:09
docs/LOCAL_DEPLOYMENT.md Outdated Show resolved Hide resolved
docs/NON_DEVCONTAINER_SETUP.md Outdated Show resolved Hide resolved
docs/NON_DEVCONTAINER_SETUP.md Outdated Show resolved Hide resolved
docs/NON_DEVCONTAINER_SETUP.md Show resolved Hide resolved
docs/NON_DEVCONTAINER_SETUP.md Show resolved Hide resolved
docs/NON_DEVCONTAINER_SETUP.md Outdated Show resolved Hide resolved
@gaurarpit gaurarpit disabled auto-merge May 23, 2024 12:42
Copy link
Collaborator

@adamdougal adamdougal left a comment

Choose a reason for hiding this comment

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

Nice!

@liammoat liammoat added this pull request to the merge queue May 24, 2024
Merged via the queue into main with commit fb26463 May 24, 2024
9 checks passed
@liammoat liammoat deleted the limoat/866/non-devcontainer-docs-for-mac branch May 24, 2024 18:24
Copy link

🎉 This PR is included in version 1.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

DevContainer doesn't work on Mac.
5 participants