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

Update to use XDG locations everywhere #208

Closed
wants to merge 1 commit into from
Closed

Update to use XDG locations everywhere #208

wants to merge 1 commit into from

Conversation

PureTryOut
Copy link

Depends on:

Description

Updates the documentation to use XDG locations. I decided to use e.g. $HOME/.config rather than $XDG_CONFIG_DIR as most people will not have the XDG variables set, and the ones who do know what they're doing already and should realize by themselves they have to update the locations as shown.

Please check properly if I missed anything or made mistakes, this was just done using some quick grep -r and I might've misunderstood certain locations as used by e.g. Docker or the Mark 1 device.

Type of PR

If your PR fits more than one category, there is a high chance you should submit more than one PR. Please consider this carefully before opening the PR.
Either delete those that do not apply, or add an x between the square brackets like so: - [x]

  • Bugfix
  • Feature implementation
  • Refactor of code (without functional changes)
  • Documentation improvements
  • Test improvements

Copy link
Contributor

@krisgesling krisgesling left a comment

Choose a reason for hiding this comment

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

Thanks heaps for updating this too.

It would be good to find a way to mention the XDG variable without needing to go into an explanation about it and the default path every time. But I think you're right that for the vast majority of users the default path will be the location and it's much easier to read it like this.

I wonder if we have a dedicated page that outlines the standard paths for all Mycroft files and directories? There's not that many and it's even more simplified with this XDG shift.

@PureTryOut
Copy link
Author

I wonder if we have a dedicated page that outlines the standard paths for all Mycroft files and directories?

Agreed. I made a simple page at docs/using-mycroft-ai/file-locations.md, please give some feedback on it (or push changes yourself, that's fine by me too) 😄

@PureTryOut PureTryOut closed this by deleting the head repository Aug 23, 2022
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