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

Landing page on a public URL with docs (other than Marketplace) #300

Open
1 task done
kingdonb opened this issue Jun 27, 2022 · 2 comments
Open
1 task done

Landing page on a public URL with docs (other than Marketplace) #300

kingdonb opened this issue Jun 27, 2022 · 2 comments
Milestone

Comments

@kingdonb
Copy link
Collaborator

kingdonb commented Jun 27, 2022

We have this landing page: https://marketplace.visualstudio.com/items?itemName=Weaveworks.vscode-gitops-tools

But we should have a different page that we can use for hosting docs. Put them on a GitHub Pages site where we can direct people to go read our docs, the Beginners/Getting Started for New To Flux and New To GitOps, vs Seasoned Flux Users page, etc. All of our docs should be hosted there and navigable. It should have a single "funnel/call-to-action" page where the Gif that demonstrates how to use VSCode Extension in order to achieve basic GitOps is hosted.

I'm skeptical that we can get any navigation or tabbed elements to work in our webview as when I first tested it, rendering was great but links all did not work; but if we enable JavaScript I think it's possible to do some single-page navigation. I would like for the beginner docs page to have an easy callout that directs users to the more advanced docs, in case the "GitOps Is Easy" copy doesn't provide them with the depth of information they're looking for.

We should have more advanced docs that call out to the Flux docs in roughly the order that we think users will need to learn about Flux features. That is all out of scope for this, but a "More VSCode/Flux Docs Coming Soon Here - Watch This Space" could be in scope if it looks nice and doesn't detract too much.

@kingdonb
Copy link
Collaborator Author

kingdonb commented Jun 27, 2022

To go with this, the fluxcd keyword returns no results, we have information in #298 (comment) about where we should add it to make sure the search returns our ext. done

@kingdonb kingdonb added this to the 0.19.x milestone Jul 1, 2022
@kingdonb kingdonb changed the title More SEO - landing page on a public URL Landing page on a public URL with docs (other than Marketplace) Jul 1, 2022
@kingdonb
Copy link
Collaborator Author

As a follow-up to #319 we need to build a workflow that publishes the new doc to a GitHub Pages target on release. No need to preserve historical versions for now, we'll hopefully only need one version of this page and we can iterate on it additively.

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

No branches or pull requests

1 participant