Open documentation in a Webview #271
Conversation
kingdonb
force-pushed
the
open-webview-document
branch
from
5d8f386 to
8ab2711
Compare
kingdonb
force-pushed
the
open-webview-document
branch
2 times, most recently
from
8a760b1 to
b54c6bf
Compare
The node-fetch package provides a fetch method which we can use to retrieve some docs from a remote source, then display it in an editor panel as webview. Add a reference to the GitOps VSCode docs (content to-be-created) Add a menu entry which triggers the webview for the docs on click, in the docs tree view. Signed-off-by: Kingdon Barrett <[email protected]>
Note this did not appear to be working Signed-off-by: Kingdon Barrett <[email protected]>
kingdonb
force-pushed
the
open-webview-document
branch
from
b54c6bf to
ec6305f
Compare
|
This is the main feature planned for 0.20.0 – @juozasg has been working on some GIF documentation that we've been closing bugs to make sure that everything is perfect when we record. If you are tracking the prerelease branch then you will find this feature as WIP, it's in the The next step is to add the content from our document work that is outside of git |
|
is a pre-requisite of this IMHO. We can load documentation from a webview, but in order to control formatting that webview should probably point somewhere other than a page on GitHub. When we are publishing a GitHub Page with each release, we can keep a versioned history or we can simply promote the latest version always. (I do not think we will try to provide versioned docs at least until after the pre-release or beta period is over.) |
The (prerelease) build failed: https://github.com/weaveworks/vscode-gitops-tools/actions/runs/2597498382 Signed-off-by: Kingdon Barrett <[email protected]>
|
This can close since it was replaced by #319 (it might be useful later, if someone needs to fetch from a URL, but the new feature uses |
This is the internal docs branch
We will replace this link to the repository for vscode-gitops-tools with a reference to our "intro to gitops with VSCode extension" docs page, when we have one ready.