Skip to content

/ beets

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

Jump to bottom

Audit the wiki pages #3283

Open
arcresu opened this issue Jun 1, 2019 · 2 comments
Open

Audit the wiki pages #3283

arcresu opened this issue Jun 1, 2019 · 2 comments
Labels
discussion docs project

Comments

@arcresu
Copy link
Member

@arcresu arcresu commented Jun 1, 2019 •
edited

Some of our wiki pages are outdated. User manual or developer guide type information should move into the sphinx docs for better visibility and so that it's versioned with the code. I think it makes sense to use the wiki for longer-term planning or planning of big changes, with the target audience being beets contributors. Where possible smaller plans can go to issues on beets with appropriate labels, and pages planning many separate changes can be broken up. That would minimise duplication of information and keep discussions together. GitHub milestones can also be used like epics to group sub-issues.

Here are some thoughts so we can discuss:

. Wiki page Type Proposed change
❌ Architecture Dev reference Move to sphinx #3295
✔️ Attachment Proposal Planning None
✔️ Attachments Planning None
💭 Beets Web UI Planning This is outdated. Move any unimplemented features to issues.
💭 Concepts User documentation Move to sphinx #2277
❌ Cookbook User documentation Move to sphinx #3285
❌ Database structure Dev reference Probably outdated. Delete or move to sphinx. Deleted.
💭 Hacking Developer reference Move to a new CONTRIBUTING file #2103
✔️ Issues Maintainer reference We can probably delete this? Kept
💭 MacOSX User documentation Probably not relevant any more? If it is then move to sphinx.
❌ MediaFile Developer reference Delete after confirming migration to beetbox/mediafile sphinx docs. Deleted
✔️ Optimization Planning None
💭 Packaging Packager reference Delete but add a new page to the sphinx docs for distro packagers.
💭 Playlists & CUE Sheets Planning Merge into attachment proposal or standalone issues.
✔️ PluginAPI Planning None
❌ PriorArt Planning Not sure of the purpose. Maybe extract into concrete proposals? Deleted
✔️ Python3 Planning None
💭 Refactoring Planning Break into separate issues with a refactor label
✔️ ReleaseChecklist Maintainer reference Maybe move to comments in release.py? Kept
💭 ReleasePlanning Planning Merge with other planning pages/issues
💭 String literals Developer reference Also move to CONTRIBUTING file
💭 Testing Developer reference Also move to CONTRIBUTING file
💭 Meet the users/devs Community Proposed in #2386.
@sampsyo
Copy link
Member

@sampsyo sampsyo commented Jun 1, 2019 •
edited

Thank for cataloging these! Here are a few notes on some of the pages:

  • Architecture would indeed make a nice Sphinx page, with some polish.
  • Cookbook: this is basically the same idea as the "advanced awesomeness" page in Sphinx.
  • Database structure: Delete. I think the source code is a better source of truth, and mirroring it in human-readable form doesn't help much.
  • Issues: I guess I don't mind keeping this, since it spells out a piece of our process that isn't listed anywhere else?
  • PriorArt: Wow; this one is old! It's from the very early days when I was trying to figure out what beets should be. Delete!
  • Release checklist: I very much rely on this to do releases---it's super helpful to be able to read down the list and be sure that I'm not forgetting anything. I think we should keep it on the wiki.
@arcresu
Copy link
Member Author

@arcresu arcresu commented Jun 1, 2019

Thanks! I updated the list above and deleted the pages you mentioned. I'll keep working on the other pages over time.
This was referenced Jun 1, 2019
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussion docs project
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@sampsyo @arcresu
You can’t perform that action at this time.