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

[feat]: Include docs in eOS #1515

Closed
1 task done
PLK2 opened this issue Jun 9, 2022 · 10 comments
Closed
1 task done

[feat]: Include docs in eOS #1515

PLK2 opened this issue Jun 9, 2022 · 10 comments
Assignees
Labels
Community Issues that we would accept PRs for but will not dedicate internal resources to Enhancement New feature or request Good First Issue suitable for a new contributors Needs Scoping Requirements are not fully defined UI Issues pertaining to any of the embassy-served web applications

Comments

@PLK2
Copy link

PLK2 commented Jun 9, 2022

Prerequisites

  • I have searched for existing issues that already suggest this feature, without success.

Describe the Feature Request

Provide an option to download a copy of the Embassy manual, to be stored locally on the embassy.

Describe the Use Case

For local troubleshooting purposes, in case internet is out or slow or whatever. Also just easier/faster to have it local.

Describe Preferred Solution

No response

Describe Alternatives

No response

Anything else?

No response

@PLK2 PLK2 added the Enhancement New feature or request label Jun 9, 2022
@kn0wmad
Copy link
Contributor

kn0wmad commented Jun 9, 2022

We have considered this, but it is quite large (or would need to be adapted to a skinnier version). We would love to see a PR for this ;)

@kn0wmad kn0wmad added Community Issues that we would accept PRs for but will not dedicate internal resources to UI Issues pertaining to any of the embassy-served web applications Needs Scoping Requirements are not fully defined Good First Issue suitable for a new contributors labels Jun 9, 2022
@kn0wmad kn0wmad assigned elvece and unassigned dr-bonez Jun 9, 2022
@PLK2
Copy link
Author

PLK2 commented Jun 9, 2022

Yeah, wasn't sure how large it would be. Not critical; I just like to keep manuals offline and adjacent to where they may be needed.

@kn0wmad
Copy link
Contributor

kn0wmad commented Jun 9, 2022

Totally agree, it will be nice to have

@chrisguida
Copy link
Contributor

We could put a link to this in the top left where the Start9 icon is

@kn0wmad
Copy link
Contributor

kn0wmad commented Jun 10, 2022

The point of this issue is to have a local copy

@chrisguida
Copy link
Contributor

Yes, I know....

@ProofOfKeags
Copy link
Contributor

I think the better answer here is to cache a copy of the centralized manual every time you fetch it and then try to update it periodically. Centrally managed docs are going to be more up to date and caching them locally should alleviate concerns about accessibility without Start9's presence.

@elvece elvece changed the title [feat]: Local html copy of Embassy Manual [feat]: Include docs in eOS Dec 14, 2022
@elvece
Copy link
Member

elvece commented Dec 14, 2022

Fetch the latest compatible version of docs

@MattDHill
Copy link
Member

Closing in favor of a "Docs" package

@MattDHill MattDHill closed this as not planned Won't fix, can't repro, duplicate, stale Mar 16, 2023
@kn0wmad
Copy link
Contributor

kn0wmad commented Mar 16, 2023

Closed in favor of Start9Labs/docs#4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Issues that we would accept PRs for but will not dedicate internal resources to Enhancement New feature or request Good First Issue suitable for a new contributors Needs Scoping Requirements are not fully defined UI Issues pertaining to any of the embassy-served web applications
Projects
None yet
Development

No branches or pull requests

7 participants