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

WIP: Site Refresh #247

Merged
merged 31 commits into from
Oct 16, 2020
Merged

WIP: Site Refresh #247

merged 31 commits into from
Oct 16, 2020

Conversation

austinlparker
Copy link
Member

@austinlparker austinlparker commented Sep 3, 2020

For #203

@ffe4 ffe4 mentioned this pull request Sep 17, 2020
4 tasks
@ffe4
Copy link

ffe4 commented Sep 17, 2020

Should we pick up here from #203 to reduce crosstalk (the issue is called Docs Section Rework after all)? I'm not sure if you want to get the whole site done in this PR, so it might be better to move the discussion into separate issues?

One thing I noticed while scrolling was that the fixed navbar does not really work as well when it's transparent.

Screen Shot 2020-09-17 at 20 35 16

On 1080p, Chrome with bookmarks bar, I also have to scroll to reach the scroll button.

As I mentioned in the issue, I think it would be good to define the content we want to have first and then build around that, so I'll try to share some of my thoughts. For now, just on the landing page.

Regarding content I think we must have on the landing page:

  • blurb explaining OpenTelemetry
  • link to getting started guide
  • mention of library and language support

I think all of these should be included in the first impression on desktop. I think library and language support deserves an extra section, however, so I would make that the first scroll target, and tease it either via text near the scroll, or by adjusting the layout so that the section heading is visible without scrolling on most desktop browsers.

We might also want to have:

  • link to GitHub
  • exporters
  • some talk about metrics and tracing (and logs?)

The GitHub link can go in the header. Not sure whether exporters are an important selling point or not, but they represent the next step after instrumentation, so it makes sense to have them be the section after library support. However, I am not sure what to do about the metric/tracing topic. It might kind of fit in with exporters, but maybe they should be mentioned in the blurb, and then be part of a detailed description of the problem domain and OpenTelemetry's role in it on another page.

Anything you think we should or should not have?

@jkowall
Copy link
Contributor

jkowall commented Oct 8, 2020

Before I submit a PR, I wanted to suggest some new text:

Current:
Robust and portable metrics, logs, and traces for cloud-native software.
OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.

Proposed 1 :
Metrics, logs, and traces for the cloud-native engineer
OpenTelemetry is a set of multi-language open source APIs, libraries, and agents to capture distributed logs, traces, and metrics from your application and infrastructure. The collector delivers telemetry to the observability system of your choosing, including popular CNCF projects like Prometheus and Jaeger.

Proposed 2 :
Metrics, logs, and traces for the cloud-native engineer
OpenTelemetry is a set of open source APIs, libraries, and agents to capture distributed logs, traces, and metrics and deliver telemetry to the observability system of your choosing.

I am also working on design elements for the technology list and an overall high-level diagram with icons for the components. One of our designers did this for me, which is already more usable.

image

@austinlparker
Copy link
Member Author

ok, there might be some nitpicks but I think I've got enough of the site moved over that we can think about pushing it out and getting started on content dev

cc @mtwo for review

@austinlparker austinlparker merged commit 2b4c3eb into open-telemetry:master Oct 16, 2020
MikeGoldsmith pushed a commit to MikeGoldsmith/opentelemetry.io that referenced this pull request Oct 22, 2020
- Switch to Docsy theme.
- Refactor content architecture to prep for docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants