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

Add https://support.planetcom.co.uk wiki pages. #21

Open
shymega opened this issue May 4, 2023 · 2 comments
Open

Add https://support.planetcom.co.uk wiki pages. #21

shymega opened this issue May 4, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@shymega
Copy link
Collaborator

shymega commented May 4, 2023

Currently a WIP, but I've managed to extract most of the Planet Computers' official support wiki pages, and will be merging into this wiki once I've tidied things up.

shymega added a commit that referenced this issue May 4, 2023
Needs editing, tidying up, and grammar/spelling checks.

Fixes #21.
@ZimbiX
Copy link
Member

ZimbiX commented May 24, 2023

As I DM'd, I'm not sure this effort is advisable.

I believe maintaining duplicated content to be an unnecessary burden (although updates to Planet's wiki will probably be extremely infrequent, given their track record of late).

I know you want this wiki to supplant the official one, but I'd only recommend doing this once Planet Computers actually agree to that, or at least agree to having a user-editable one.

If you want to go down the duplication path, it'd probably be a good idea to have a system in place to make it easier to know about what changed in the original wiki - e.g. having CI maintain a cache of the original's HTML files, perform diffs, and notify you if there's a change.

@shymega
Copy link
Collaborator Author

shymega commented May 29, 2023

I don't think this is too much of an issue for Planet. They're aware of this wiki, and I've already copied their wiki into a branch.

The problem is, they could go bust, and we need to duplicate the firmware hosted there for future usage. CI wouldn't.. really work, I had to do some cURL hackery, and then delete content that was stub pages, etc. It's just not ideal to do that with CI. Especially with HTML sources.

I'd like to get other community thoughts on this effort as well - so it's not just us two :)

@shymega shymega added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 10, 2023
shymega added a commit that referenced this issue Aug 5, 2023
Needs editing, tidying up, and grammar/spelling checks.

Fixes #21.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants