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

Publish as website #522

Open
virgile-dev opened this issue Dec 20, 2024 · 4 comments
Open

Publish as website #522

virgile-dev opened this issue Dec 20, 2024 · 4 comments

Comments

@virgile-dev
Copy link
Collaborator

virgile-dev commented Dec 20, 2024

Feature Request

Is your feature request related to a problem or unsupported use case? Please describe.
As Docs will support sub-pages, users will want to publish docs and sub-docs as websites.

Describe the solution you'd like
A published page should display a minimilized interface of Docs (no versioning for instance, no sharing panel, no login button or home page button).
This feature implies creating a user flow for publishing a page as we'll have to offer some settings for publication (allow for search engine indexing for ex).
We might want to add a bunch of features like adding a cover image so that the website look nice or custom domain support.

For now let's figure out what an MVP looks like:

  • publish as website menu
  • config panel :
    • Index by search engine toggle
  • alert banner on doc page
  • grid view indication that a page is published
  • Website view (minimal docs UI)
    • "Created with docs" mention

Discovery, Documentation, Adoption, Migration Strategy
Notion has been knowned for providing this features, here are bunch of screens related to that user flow.
Publish tab in share modal:
Image
Publish config panel:
Image
Website view:
Image
Alert banner in-app:
Image
Customize UI config panel:
Image

@virgile-dev virgile-dev converted this from a draft issue Dec 20, 2024
@virgile-dev virgile-dev assigned virgile-dev and rl-83 and unassigned virgile-dev Dec 20, 2024
@virgile-dev virgile-dev changed the title Publish as website (domains) Publish as website Dec 20, 2024
@virgile-dev virgile-dev moved this to To do in Docs - La Suite Dec 20, 2024
@rl-83
Copy link
Collaborator

rl-83 commented Dec 20, 2024

First proposition, simple to do, and no need for a new sharing mode : just click public and share the link, the viewer will see the screenshot below.

Image

The Logo + connexion button can be moved elsewhere / changed to be more or less prominent.

FIGMA HERE

@virgile-dev
Copy link
Collaborator Author

virgile-dev commented Jan 7, 2025

Yowa needs this to publish a page announcing an event for rules as code.
@sampaccoud would it be tricky to support custom domains like Notion does ?

@sampaccoud
Copy link
Member

@virgile-dev I would say feasible but not trivial as it involves creating ingresses in Kubernetes on the fly. Anything easier than that @rouja ?
It also raises the question of what domains we would allow...

@rouja
Copy link
Contributor

rouja commented Jan 8, 2025

It might be the simplest, but it’s not trivial. On-the-fly ingress is one example, while DNS and certificates are others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants