Skip to content

Consolidate hostname notes#884

Draft
jonathan-conder wants to merge 1 commit into
mainfrom
feature/dns
Draft

Consolidate hostname notes#884
jonathan-conder wants to merge 1 commit into
mainfrom
feature/dns

Conversation

@jonathan-conder

Copy link
Copy Markdown
Contributor

Description

Fix these to make explicit mention of the hostname and drop the reason why the ideal hostname wasn't used. We should explain this in the docs at some point:

  • for hostname-fallback, either the friendly project name was already taken by another project, or the name is invalid for a hostname (e.g. foo@bar; we do support some invalid names: foo_bar, foo.bar and foo bar all become foo-bar)
  • for hostname-missing, an error occurred and should have been logged in journalctl -u snap.workshop.workshopd.service; the most likely one is a clash between an existing project name and a new project ID (which is very unlikely)

Self-review quick check

  • Make decisions that cost a lot to reverse explicit in the PR description.
  • Avoid nested conditions.
  • Delete dead code and redundant comments.
  • Normalise symmetries by sticking to doing identical things identically.
// one way to handle errors
if err := f(); err != nil {
   ...
}

// one way to handle multiple returns
val, err := f()
if err != nil {
   ...
}
...
  • Check that coupled code elements, files, and directories are adjacent. For example, test data is stored as close as possible to a test.
  • Put variable declaration and initialisation together.
  • Divide large expressions into digestable and self-explanatory ones. Use multiple variables if required.
  • Put a blank line between two logically different chunks of code.
  • Follow the style guide for new error messages.

Docs

Procedure:

  • I have checked and added or updated relevant documentation.
  • I have checked and added or updated relevant release notes.
  • I have included the technical author in the review.

Content:

  • Headings and titles accurately describe the content.
  • New and updated pages include correct metadata.
  • Documentation tests are added or updated where applicable (for tutorial/ and how-to/ sections).
  • Documentation follows the style guide.
  • If needed, docs/.coverage.yaml updated, coverage tags added (.. artefact).

Or:

  • I confirm the PR has no implications for documentation.

@jonathan-conder jonathan-conder self-assigned this Jun 23, 2026
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.

1 participant