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.

Sign up for GitHub

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

Jump to bottom

docs: add website for user documentation #219

Merged
merged 4 commits into from
Mar 12, 2024
Merged

docs: add website for user documentation #219

merged 4 commits into from
Mar 12, 2024

Conversation

m1ghtym0
Copy link
Member

@m1ghtym0 m1ghtym0 commented Mar 8, 2024 •
edited by katexochen
Loading

  • Add docs folder with docusaurus setup
  • Add github action to publish docs build to gh-pages branch
  • Docs will be served from there via github pages

TODO:

Preview: https://deploy-preview-88--edgeless-docs.netlify.app/contrast

@m1ghtym0 m1ghtym0 requested a review from katexochen as a code owner March 8, 2024 09:45
@katexochen
Copy link
Member

docs/styles/* is only consumed by vale, right?

@m1ghtym0
Copy link
Member Author

m1ghtym0 commented Mar 8, 2024

docs/styles/* is only consumed by vale, right?

correct

@katexochen
Copy link
Member

docs/styles/* is only consumed by vale, right?

correct

We should move those files into a separate PR then that also introduces vale.

@katexochen
Copy link
Member

@m1ghtym0 is there a way to get a preview with github-pages? Will we continue to use the netlify preview?

katexochen and others added 4 commits March 8, 2024 15:52
@katexochen @m1ghtym0
docs: add docusaurus skeleton
3941b46 
Co-authored-by: Moritz Eckert <[email protected]>
Signed-off-by: Paul Meyer <[email protected]>
@katexochen @m1ghtym0
ci: add workflow to publish docs
495625b 
Co-authored-by: Moritz Eckert <[email protected]>
Signed-off-by: Paul Meyer <[email protected]>
@katexochen
docs: upgrade to docusaurus v3
eb852bb 
Signed-off-by: Paul Meyer <[email protected]>
@katexochen
flake: add devShell for docs
a8b5790 
Signed-off-by: Paul Meyer <[email protected]>
@katexochen katexochen changed the title docs: add docusaurus skeleton docs: add website for user documentation Mar 12, 2024
@katexochen katexochen added the feature Shiny new feature for our users label Mar 12, 2024
@m1ghtym0
Copy link
Member Author

Unfortunately, the correct preview redirects are handled via netlify: https://github.com/edgelesssys/ego/pull/235/files#diff-b894bd26d8762b77b2d6e81d714324c0e212918a55ae7173477def08573c8825

@katexochen katexochen requested a review from 3u13r March 12, 2024 13:34
3u13r
3u13r approved these changes Mar 12, 2024
View reviewed changes
Copy link
Member

@3u13r 3u13r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@katexochen katexochen merged commit 69f1f51 into main Mar 12, 2024
7 checks passed
@katexochen katexochen deleted the feat/docs branch March 12, 2024 13:58
@katexochen katexochen added documentation Improvements for user docs and removed feature Shiny new feature for our users labels Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@3u13r 3u13r 3u13r approved these changes

@katexochen katexochen Awaiting requested review from katexochen katexochen is a code owner

Assignees
No one assigned
Labels
documentation Improvements for user docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@m1ghtym0 @katexochen @3u13r