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

Documentation updates #452

Merged
merged 5 commits into from
Oct 12, 2021
Merged

Documentation updates #452

merged 5 commits into from
Oct 12, 2021

Conversation

ryan-summers
Copy link
Member

This PR fixes a variety of issues noted in #339 (comment)

This PR also fixes #449 by adding a .gitattributes file that forces the mosquitto config file to be checked out with LF line endings. It appears more recent versions of mosquitto require this.

@svrotter
Copy link
Collaborator

svrotter commented Oct 8, 2021

I think this should fix most of the issues I pointed out in #339 regarding the getting started section.
As @jordens pointed out in the matrix chat he doesn't consider the setup for a broker on the local machine as relevant at his point, but is there a reason that you didn't touch the miniconf installation in the usage section?

I think we also had some problems there, but @jordens could have to say more about it than me

@ryan-summers
Copy link
Member Author

is there a reason that you didn't touch the miniconf installation in the usage section?

I think we also had some problems there, but @jordens could have to say more about it than me

From what I can tell, the only deviation that was made was to use a python virtual environment, which is really a user consideration IMO. If we want to steer users down that path, we can do so. Curious to hear this either way (I don't typically use virtual environments, but I see their benefits for sure).

@jordens
Copy link
Member

jordens commented Oct 8, 2021

IME python venvs are really easy to use, don't need much space and provide an excellent isolation. For example, as a developer you want something like venvs as soon as you are both developing python packages and using them elsewhere. Or if you ever need to isolate yourself from system python packages which may be of a different version etc. And if we use requirements.txt for the manual, that's already tested and synchronized to CI. Even shortens the manual instructions.

@ryan-summers
Copy link
Member Author

@svrotter / @jordens Documentation has now been updated to point users towards using a virtual environment for pip package management

@github-actions github-actions bot added the changes-hitl Changes HITL scripts, needs close review label Oct 12, 2021
@ryan-summers
Copy link
Member Author

bors try

bors bot added a commit that referenced this pull request Oct 12, 2021
@bors
Copy link
Contributor

bors bot commented Oct 12, 2021

try

Build failed:

hitl/run.sh Outdated Show resolved Hide resolved
book/README.md Outdated Show resolved Hide resolved
@ryan-summers
Copy link
Member Author

bors try

bors bot added a commit that referenced this pull request Oct 12, 2021
@bors
Copy link
Contributor

bors bot commented Oct 12, 2021

try

Build succeeded:

@ryan-summers
Copy link
Member Author

bors merge

@bors
Copy link
Contributor

bors bot commented Oct 12, 2021

Build succeeded:

@bors bors bot merged commit 3c53c5d into master Oct 12, 2021
@bors bors bot deleted the rs/issue-339/doc-fixes branch October 12, 2021 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes-hitl Changes HITL scripts, needs close review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mosquitto.conf fails with mosquitto v2.0.12
3 participants