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

improvements to the documentation #1067

Merged
merged 3 commits into from
Sep 6, 2022

Conversation

eladyn
Copy link
Member

@eladyn eladyn commented Mar 10, 2022

This PR adds the new page that was added in #1030 to the summary, so that it also appears in the sidebar.

It also removes the configuration sections from individual installation pages and replaces them with links to the configuration section. This should make sure that there is more or less a single source of truth regarding the config file.

The "Running as a Service" section was previously a draft page, which was replaced with a proper page shortly summarizing the contents of this chapter.

Closes #1052, since it removes the relevant section.
Fixes #1031 (now points to a section with the correct example config)

Fix a typo in a filename, add the FreeBSD installation instructions to
the SUMMARY and make the "Running as a Service" page a non-draft page.
@debdrup
Copy link

debdrup commented Mar 13, 2022

The FreeBSD port/package comes with the rc.d service file necessary to start spotifyd as a service, so if you want to add instructions for how to run as a service on FreeBSD, it's as simple as:

1: Edit config file

2: service spotifyd enable

3: service spotifyd start

@eladyn
Copy link
Member Author

eladyn commented Mar 14, 2022

@debdrup Looks like a good suggestion! As I have only little experience with FreeBSD, I'm not really sure how to fit that in here correctly (especially since there seems to be already something similar in the docs). Feel free to open a separate PR for this (or otherwise suggest changes directly to this one)!

@debdrup
Copy link

debdrup commented Mar 14, 2022

@debdrup Looks like a good suggestion! As I have only little experience with FreeBSD, I'm not really sure how to fit that in here correctly (especially since there seems to be already something similar in the docs). Feel free to open a separate PR for this (or otherwise suggest changes directly to this one)!

I'll be honest, I hadn't seen those docs. 😊

service <entry> enable is just a wrapper around sysrc, so it's perfectly correct to use that over the other.

@eladyn eladyn requested a review from robinvd March 18, 2022 17:43
@SimonTeixidor SimonTeixidor merged commit b75d79e into Spotifyd:master Sep 6, 2022
@SimonTeixidor
Copy link
Member

Thanks!

@eladyn eladyn deleted the docs_improvements branch September 6, 2022 20:48
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.

https://spotifyd.github.io/spotifyd/config/File.html conf file issue
5 participants