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

Add demo docs, temporarily via git submodule #2246

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Feb 1, 2023

  • Closes Host demo docs on the website and possibly migrating them to this repo #2173 by bringing in the demo docs as is, via a git submodule.
  • I propose this as a first cut, until the demo docs are frozen, after which we'll be able to migrate them from the demo repo to here. In the meantime, I'll submit some front-matter parameters to the demo repo to change the section weight, add linkTitles, etc.

WDYT @svrnm @cartermp @austinlparker @open-telemetry/demo-approvers ?

Preview: https://deploy-preview-2246--opentelemetry.netlify.app/docs/demo

p.s. I know that the scripts are misnamed, but I wanted to keep changes to a minimum in this PR.

@chalin chalin added the enhancement New feature or request label Feb 1, 2023
@chalin chalin requested a review from a team as a code owner February 1, 2023 16:28
@chalin chalin added the demo label Feb 1, 2023
Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

I like it!

@svrnm
Copy link
Member

svrnm commented Feb 2, 2023

I like it as well! One suggestion: There's a lot of documents below the top level navigation, maybe there should be some folders?

@chalin
Copy link
Contributor Author

chalin commented Feb 2, 2023

There's a lot of documents below the top level navigation, maybe there should be some folders?

Yes, I can fix that in the demo repo (for the doc sections that already exist) once this lands. WDYT?

@cartersocha
Copy link
Contributor

@chalin I think we're comfortable calling the docs stable. @open-telemetry/demo-approvers feel free to chime in otherwise

@julianocosta89
Copy link
Member

The only thing that doesn't look nice is the architecture page, where we are using Mermaid in GH, but in the docs we have just the text.
Would it be possible to either not add this doc, or render the mermaid in the docs?

@chalin chalin force-pushed the chalin-im-demo-docs-take-1-2023-02-01 branch from 9b8a8ab to 70ff132 Compare February 3, 2023 20:34
@chalin
Copy link
Contributor Author

chalin commented Feb 3, 2023

Thanks for the feedback @cartersocha and @julianocosta89.

render the mermaid in the docs?

@julianocosta89 - done, see https://deploy-preview-2246--opentelemetry.netlify.app/docs/demo/current_architecture/. Best viewed on a wide display. (I'll try to fix the layout in a followup PR.)

With this change in, can someone from the demo team approve this PR?

@chalin
Copy link
Contributor Author

chalin commented Feb 3, 2023

Thanks @reyang!

I've updated the submodule to refer to the current HEAD. Note that "View page source" etc, won't work until I move the pages into this repo. (I could get them to work, but it isn't worth implementing it for this temporary situation.)

Merging!

@chalin chalin merged commit cd431d8 into open-telemetry:main Feb 3, 2023
@chalin chalin deleted the chalin-im-demo-docs-take-1-2023-02-01 branch February 3, 2023 20:49
@chalin chalin mentioned this pull request Feb 3, 2023
8 tasks
@chalin chalin changed the title Add demo docs Add demo docs, temporarily via git submodule Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
demo enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Host demo docs on the website and possibly migrating them to this repo
6 participants