Additional documentation for etc/hosts configuration issue

[KesterTan]

Description

Adds clearer documentation for #2260.

The same documentation appears in troubleshooting of docker compose but I think searching in Tango's documentation when facing this issue is also an equally valid response.

How Has This Been Tested?

Ran python3 -m mkdocs serve.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
• My change requires a change to the documentation, which is located at Autolab Docs
• I have updated the documentation accordingly, included in this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the Autolab installation documentation. In the docker-compose instructions, it now specifies that users accessing Autolab from a different host should add a line with their public IP, fully-qualified domain name, and the alias “autolab” to their /etc/hosts file. Additionally, a new section in the tango troubleshooting document explains how to address issues with Tango jobs where scores are not updated, instructing users to modify their /etc/hosts file accordingly. There are no changes to any exported or public entities.

Changes

File(s)	Summary
docs/installation/docker-compose.md	Updated instructions for remote access: users should add <your public_ip> <your fqdn> autolab to /etc/hosts to access Autolab via http://autolab instead of using localhost.
docs/installation/tango-troubleshoot.md	Added a new section titled “Tango jobs completed but scores are not updated” with troubleshooting guidance, including modifying /etc/hosts (using 127.0.0.1 autolab for localhost or <your public_ip> <your fqdn> autolab for remote access) to resolve score update issues.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/installation/docker-compose.md (1)

311-312: Clarify instructions for non-localhost access.

The newly added instruction instructs users accessing Autolab from a different host to update their /etc/hosts file accordingly. This addition improves clarity for non-local users. Consider providing an example or a brief note on how users might determine their public IP and FQDN if needed.

docs/installation/tango-troubleshoot.md (2)

15-16: Consider punctuation in the section header.

The new section header
## Tango jobs completed but scores are not updated
is clear in intent. For improved readability, consider adding a comma before “but” (i.e., “## Tango jobs completed, but scores are not updated”). This is a stylistic suggestion and optional in markdown headers.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~15-~15: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ....0.1:6379> ``` ## Tango jobs completed but scores are not updated If you are acces...

(COMMA_COMPOUND_SENTENCE_2)

---

20-20: Instruction for non-localhost users is well-defined.

The new instruction for users accessing Autolab from a different host clearly outlines the required update to the /etc/hosts file. Ensure that users understand they must substitute <your public_ip> and <your fqdn> with their actual network values. This consistency with the updated Docker Compose documentation is beneficial.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9e96814 and 22f4ebf.

📒 Files selected for processing (2)

• docs/installation/docker-compose.md (1 hunks)
• docs/installation/tango-troubleshoot.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/installation/tango-troubleshoot.md

[uncategorized] ~15-~15: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ....0.1:6379> ``` ## Tango jobs completed but scores are not updated If you are acces...

(COMMA_COMPOUND_SENTENCE_2)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (1)

docs/installation/tango-troubleshoot.md (1)

16-18: Explain the localhost limitation and fix.

The added lines explain that when accessing Autolab via localhost, Tango sends autograder logs to its own localhost. This clarifies the root cause and provides the necessary fix by updating the /etc/hosts file. The explanation is concise and effective.