Skip to content
This repository was archived by the owner on Oct 4, 2022. It is now read-only.

docs: Add docs website#103

Merged
sipsma merged 1 commit into
dagger:mainfrom
jpadams:docs_website
Sep 2, 2022
Merged

docs: Add docs website#103
sipsma merged 1 commit into
dagger:mainfrom
jpadams:docs_website

Conversation

@jpadams
Copy link
Copy Markdown
Contributor

@jpadams jpadams commented Aug 24, 2022

Signed-off-by: Jeremy Adams jeremy@dagger.io

@jpadams jpadams force-pushed the docs_website branch 2 times, most recently from 26e2c57 to dad7a89 Compare August 24, 2022 00:38
@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Aug 24, 2022

Uses existing content with Docusaurus magic sprinkled on top (unique IDs, sidebar).
image

Hyperlinks between docs updated to use Docusaurus unique ID format.
image

Same workflow to create new docs.

Worked with @crjm to get Mermaid support working :)
image

Simple structure.
image

@slumbering

This comment was marked as resolved.

@jpadams

This comment was marked as resolved.

@slumbering

This comment was marked as resolved.

@jpadams

This comment was marked as resolved.

@crjm

This comment was marked as resolved.

@slumbering

This comment was marked as resolved.

@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Aug 26, 2022

Thanks for the .md vs .mdx discussion @crjm and @slumbering!

Decided: we'll use .mdx extensions only for those markdown files with jsx inside and .md for static markdown. Both kinds can contain Mermaid diagrams.

@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Sep 2, 2022

Makes our Cloak docs website the first class way to consume the Cloak docs. Consistent with the current Dagger docs. Incremental revolution of the docs! 😄

@sipsma
Copy link
Copy Markdown
Contributor

sipsma commented Sep 2, 2022

@jpadams First off, thanks for this and all the updates to incorporate the merges to main since you first sent it out!

Second, I tried yarn start locally and saw this in the output:

[WARNING] Docs markdown link couldn't be resolved: (writing_extensions.md) in "/home/sipsma/repo/github.com/sipsma/cloak/docs/unxpq-introduction.mdx" for version current

And then on the localhost site I found that the link Writing an extension in Javascript/Typescript doesn't work on the page bnzm7/writing_extensions. But the Go one right above it does work.

I don't personally think that's a blocker on merging this, but if it's trivial to fix may as well before merge, let me know. Otherwise LGTM

@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Sep 2, 2022

@jpadams First off, thanks for this and all the updates to incorporate the merges to main since you first sent it out!

Second, I tried yarn start locally and saw this in the output:

[WARNING] Docs markdown link couldn't be resolved: (writing_extensions.md) in "/home/sipsma/repo/github.com/sipsma/cloak/docs/unxpq-introduction.mdx" for version current

And then on the localhost site I found that the link Writing an extension in Javascript/Typescript doesn't work on the page bnzm7/writing_extensions. But the Go one right above it does work.

I don't personally think that's a blocker on merging this, but if it's trivial to fix may as well before merge, let me know. Otherwise LGTM

Thanks for the review, @sipsma ! Taking a look now.

@jpadams

This comment was marked as outdated.

@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Sep 2, 2022

I did find the broken link though!! Name changes are tough. Love to get ahead of them. Good catch!

@jpadams
Copy link
Copy Markdown
Contributor Author

jpadams commented Sep 2, 2022

Switched to yarn start -l debug and that caught something!

image

Signed-off-by: Jeremy Adams <jeremy@dagger.io>
Copy link
Copy Markdown
Contributor

@sipsma sipsma left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@sipsma sipsma merged commit 15ffedf into dagger:main Sep 2, 2022
@shykes
Copy link
Copy Markdown
Contributor

shykes commented Sep 2, 2022

Stupid question: where are the docs hosted?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants