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

helper domains also added to /etc/hosts in readme for local dev #61

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

eriktaubeneck
Copy link
Member

@eriktaubeneck eriktaubeneck commented Jun 25, 2024

network.conf uses url=helper<n>.draft.test, so these are also needed in /etc/hosts

Summary by CodeRabbit

  • Documentation
    • Updated the README with new instructions for adding additional local domains (helper1.draft.test, helper2.draft.test, and helper3.draft.test) to the /etc/hosts file for draft testing.

Copy link

vercel bot commented Jun 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
draft ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2024 10:53pm

@eriktaubeneck eriktaubeneck requested a review from akoshelev June 25, 2024 22:46
Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

This update introduces the addition of several local testing domains to the /etc/hosts file, specifically helper1.draft.test, helper2.draft.test, and helper3.draft.test. These changes are designed to facilitate draft environment testing without making any alterations to public entities or exported declarations.

Changes

File Change Summary
README.md Added details about including additional local domains for draft testing: helper1.draft.test, helper2.draft.test, helper3.draft.test.

Poem

In the hosts file, new friends arrive,
Helpers for your drafts, alive.
Testing now with ease and grace,
Local domains fall into place.
Code runs smooth, changes sleek,
Successful drafts, week by week. 🧑‍💻✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (2)
README.md (2)

Line range hint 1-1: Ensure headings are surrounded by blank lines.

Markdown standards recommend that headings be surrounded by blank lines to improve readability and compatibility with various markdown renderers.

+ 
# DRAFT - Distributed Relay and Automation Facilitation Tool
+ 
...
+ 
## Appendix
+ 

Also applies to: 222-222

Tools
Markdownlint

158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


Line range hint 21-21: Add language specifications to fenced code blocks.

For better syntax highlighting and readability, specify the language next to the code fences. This is especially important for commands and code snippets that users will interact with.

- ```
+ ```bash

Also applies to: 26-26, 84-84, 89-89, 145-145, 173-173

Tools
Markdownlint

158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6b7e839 and 846a566.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
Markdownlint
README.md

9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


51-51: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


67-67: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


76-76: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


96-96: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


110-110: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


118-118: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


220-220: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


221-221: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


222-222: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


222-222: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


21-21: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


84-84: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


89-89: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


145-145: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


173-173: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


20-20: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


47-47: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


53-53: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


100-100: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


204-204: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


205-205: null (MD034, no-bare-urls)
Bare URL used


206-206: null (MD034, no-bare-urls)
Bare URL used


16-16: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


119-119: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


21-21: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


70-70: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


84-84: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


89-89: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


123-123: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


135-135: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


142-142: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


148-148: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


162-162: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


168-168: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


173-173: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


179-179: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


193-193: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


214-214: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Additional comments not posted (2)
README.md (2)

155-155: Validate the command for updating /etc/hosts.

The command to update the /etc/hosts file is crucial for proper local domain resolution. Ensure that the syntax is correct and the domains are appropriately added. The command uses sudo, which is necessary for modifying the /etc/hosts file, and it appends multiple entries. It seems well-formed for the stated purpose.


Line range hint 9-9: Reduce multiple consecutive blank lines.

Multiple consecutive blank lines can disrupt the flow and structure of the document. It's best to limit to a single blank line to separate sections clearly.

-

Also applies to: 43-43, 51-51, 67-67, 76-76, 95-95, 96-96, 105-105, 110-110, 118-118, 220-220, 221-221

Tools
Markdownlint

158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 846a566 and 8afcd26.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
Markdownlint
README.md

9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


51-51: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


67-67: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


76-76: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


96-96: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


110-110: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


118-118: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


220-220: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


221-221: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


222-222: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


222-222: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


21-21: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


84-84: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


89-89: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


145-145: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


173-173: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


20-20: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


47-47: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


53-53: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


100-100: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


204-204: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


205-205: null (MD034, no-bare-urls)
Bare URL used


206-206: null (MD034, no-bare-urls)
Bare URL used


16-16: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


119-119: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


21-21: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


70-70: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


84-84: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


89-89: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


123-123: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


135-135: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


142-142: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


148-148: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


162-162: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


168-168: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


173-173: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


179-179: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


193-193: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


214-214: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Additional comments not posted (1)
README.md (1)

155-155: Update to /etc/hosts file is correct and necessary for local development.

The command provided correctly appends the necessary local development domains to the /etc/hosts file, ensuring that network.conf can resolve these URLs. This change aligns with the PR's objective to support local development environments.

@eriktaubeneck eriktaubeneck merged commit fae43d4 into main Jun 25, 2024
3 checks passed
@eriktaubeneck eriktaubeneck deleted the readme-fix branch June 26, 2024 20:36
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