Skip to content

Conversation

@tobiasge
Copy link
Member

@tobiasge tobiasge commented Jul 8, 2025

Related Issue: #1433, #1476

New Behavior

  • Use the example file in our Readme to have only one version of the configuration

Contrast to Current Behavior

  • Two example configurations might be confusing

Discussion: Benefits and Drawbacks

  • None

Changes to the Wiki

  • None

Proposed Release Note Entry

  • Use one example for docker-compose.override.yml

Double Check

  • I have read the comments and followed the PR template.
  • I have explained my PR according to the information in the comments.
  • My PR targets the develop branch.

@cimnine
Copy link
Collaborator

cimnine commented Jul 8, 2025

What I don't like is that previously you could copy&paste the command in the terminal and it will start. It's as minimal as possible. When you add something like 'edit this file here', the time-to-netbox, so to say, gets longer.

Perhaps you could just remove the 'edit the file' part? Do we have the 'ports' part in the example file?

@tobiasge
Copy link
Member Author

tobiasge commented Jul 8, 2025

What I don't like is that previously you could copy&paste the command in the terminal and it will start. It's as minimal as possible. When you add something like 'edit this file here', the time-to-netbox, so to say, gets longer.

Perhaps you could just remove the 'edit the file' part? Do we have the 'ports' part in the example file?

Yes, the ports are in the example file. I think I will leave the comment there but remove the editor command.

@tobiasge
Copy link
Member Author

@cimnine Could you take a look again?

@tobiasge tobiasge merged commit 7aeec92 into netbox-community:develop Sep 26, 2025
9 checks passed
@tobiasge tobiasge deleted the update-readme branch September 26, 2025 10:41
@tobiasge tobiasge mentioned this pull request Nov 10, 2025
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