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

Focus README on docker-compose; README fixups; reduce docker-compose dep #7

Merged
merged 2 commits into from
Oct 26, 2020

Conversation

rshaull
Copy link
Contributor

@rshaull rshaull commented Oct 23, 2020

= README.md

Move Docker Compose instructions to the top of the types of setup, and
name it "Quick Start with Docker Compose".

Fix bug in instructions to append to /etc/default/telegraf in the bare
metal instructions (use sudo tee).

Added instructions for verifying installation by checking that
nuodb_internal and nuodb databases exist in influx.

Changed Kubernetes section to say "coming soon".

Fix header depth so that each of the Setup types are at the top level.

Fix whitespace.

= docker-compose.yml

Reduce dependency from 3.7 to 3.3, seems to work just fine and is
required for the versions of docker and docker-compose on Ubuntu.

* README.md

Move Docker Compose instructions to the top of the types of setup, and
name it "Quick Start with Docker Compose".

Fix bug in instructions to append to /etc/default/telegraf in the bare
metal instructions (use sudo tee).

Added instructions for verifying installation by checking that
`nuodb_internal` and `nuodb` databases exist in influx.

Changed Kubernetes section to say "coming soon".

Fix header depth so that each of the Setup types are at the top level.

Fix whitespace.

* docker-compose.yml

Reduce dependency from 3.7 to 3.3, seems to work just fine and is
required for the versions of docker and docker-compose on Ubuntu.
README.md Outdated
Comment on lines +199 to +201
INFLUXURL=http://<hostinflux>:8086
PYTHONPATH=/opt/nuocd/pylib
EOF
Copy link
Contributor

Choose a reason for hiding this comment

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

these three lines are now duplicated. Is that on purpose?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, good catch. Must have made an error when cleaning the changes up. I'll push a fix now.

@mkysel mkysel self-requested a review October 26, 2020 14:33
Copy link
Contributor

@mkysel mkysel left a comment

Choose a reason for hiding this comment

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

It reads much better now

@mkysel mkysel merged commit 5939c60 into master Oct 26, 2020
@mkysel mkysel deleted the ross/doc-edits branch December 1, 2020 18:04
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.

3 participants