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 documentation to live #323

Closed
mbarton opened this issue Oct 16, 2024 · 2 comments · Fixed by #344
Closed

Publish documentation to live #323

mbarton opened this issue Oct 16, 2024 · 2 comments · Fixed by #344
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mbarton
Copy link
Member

mbarton commented Oct 16, 2024

Some options off the top of my head:

  1. Publish it on GitHub pages using a subdomain
  2. Publish it on GitHub pages and embed as an iframe in the main app
  3. Copy it as static files into the main app and serve with WhiteNoise (as we do with E12)

I prefer 1 or 2, 3 was only really done in a panic as I completely forgot about the docs when migrating to Azure Container Apps.

Any preference @eatyourpeas @anchit-chandran?

@mbarton mbarton added the documentation Improvements or additions to documentation label Oct 16, 2024
@mbarton mbarton self-assigned this Oct 16, 2024
@mbarton mbarton changed the title Publish documentation Publish documentation to live Oct 16, 2024
@eatyourpeas
Copy link
Member

eatyourpeas commented Oct 16, 2024

I vote for GitHub pages as a subdomain

@anchit-chandran
Copy link
Contributor

anchit-chandran commented Oct 16, 2024

1!

DIdn't know we directly serve the docs in E12, that's cool but think it's only worth later

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants