Skip to content
This repository has been archived by the owner on Oct 30, 2024. It is now read-only.

Commit

Permalink
Change README to Overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
Meschreiber committed Sep 9, 2024
1 parent bda2ea9 commit 57c41a9
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions src/content/graphos/basics/graphs/studio-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Without understanding a schema's intricacies—particularly how subgraphs relate

GraphOS Studio provides several ways of understanding and exploring your organization's graphs, including:

- An editable **README** page that describes the graph to newcomers
- An editable **Overview** page that describes the graph to newcomers
- The **Schema** page, which includes three distinct views, including schema visualization
- The **Explorer**, which helps you build new operations against your graph
- The **Changelog**, which displays all published changes
Expand All @@ -30,9 +30,9 @@ After selecting an organization in GraphOS Studio, click a particular graph vari

With Serverless and Dedicated plans, all Studio organization members have access to all pages, including **Settings** for all graphs within the organization. Enterprise accounts can set [member roles](../org/members/#organization-wide-member-roles) to configure fine-grained access for individual members of their organization.

## The README page
## The Overview page

When a user opens one of your graph's variants in GraphOS Studio, its **README** page appears:
When a user opens one of your graph's variants in GraphOS Studio, its **Overview** page appears:

<img className="screenshot" alt="GraphQL codeblock in README" src="../../img/readme-example.jpg" width="500" />

Expand Down
6 changes: 3 additions & 3 deletions src/content/graphos/basics/quickstart/cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ When you created your supergraph, you also created its first variant. Every grap

Let's look at the views that Studio provides to help you understand your variant:

From your **Graphs** tab, click your graph's `current` variant. This opens the variant's README page.
From your **Graphs** tab, click your graph's `current` variant. This opens the variant's **Overview** page.

The README is great for documenting your supergraph so team members can learn the basics of how to work with it. It supports Markdown syntax like a typical README in a Git repository.

Expand Down Expand Up @@ -341,12 +341,12 @@ Similarly, any new client applications should use your router's URL.

</Note>

Your router's URL is available from the top of your variant's **README** page, directly below the variant's graph ref.
Your router's URL is available from the top of your variant's **Overview** page, directly below the variant's graph ref.

<img
src="../../img/router-url.jpg"
className="screenshot"
alt="Router URL shown on the README page"
alt="Router URL shown on the Overview page"
width="500"
/>

Expand Down
2 changes: 1 addition & 1 deletion src/content/graphos/basics/quickstart/self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ To publish our subgraph schema, we'll first use Rover to introspect the running

Each variant of a graph represents a different environment where that graph runs (such as staging and production). For this quickstart, you can keep the default suggested variant name or change it to anything else you like (for example, `quickstart`). Just make sure to provide the same graph ref to every command in this quickstart!

After you've published a schema to a particular variant, that variant's graph ref is always available at the top of its README page:
After you've published a schema to a particular variant, that variant's graph ref is always available at the top of its **Overview** page:

<img class="screenshot" alt="Graph ref in Studio" src="../../img/studio-graph-ref.jpg" width="300"/>

Expand Down
2 changes: 1 addition & 1 deletion src/content/graphos/cloud-routing/dedicated/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Use the **Configuration** tab to manage your cloud router's configuration, inclu

## Step 4. Test and validate

To test whether your graph works as intended, run a sample query by clicking **Run in Explorer** from your graph's **README** page.
To test whether your graph works as intended, run a sample query by clicking **Run in Explorer** from your graph's **Overview** page.

[Enable subgraph error reporting](./lattice-troubleshooting/#enable-subgraph-error-inclusion) if you run into issues.

Expand Down
4 changes: 2 additions & 2 deletions src/content/graphos/explorer/operation-collections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ Team members must be signed in to Studio to view a linked collection or operatio

</Note>

### Embedding in the README page
### Embedding in the Overview page

Each graph variant in Studio has a [README page](../graphs/studio-features/#the-readme-page) that you can customize to document that variant. You can embed a variant's shared collections and operations in its README using [shortcodes](../graphs/studio-features/#readme-shortcodes) that are shown in the README editor.
Each graph variant in Studio has a [**Overview** page](../graphs/studio-features/#the-readme-page) that you can customize to document that variant. You can embed a variant's shared collections and operations in its README using [shortcodes](../graphs/studio-features/#readme-shortcodes) that are shown in the README editor.

### Public collections

Expand Down
2 changes: 1 addition & 1 deletion src/content/graphos/metrics/sending-operation-metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Both the GraphOS Router and Apollo Server use the same mechanism to enable opera

</Note>

2. Obtain the _graph ref_ for the graph and variant you want to report metrics for. You can find your variant's graph ref at the top of the variant's README page in Studio. It has the format `graph-id@variant-name` (such as `my-graph@staging`).
2. Obtain the _graph ref_ for the graph and variant you want to report metrics for. You can find your variant's graph ref at the top of the variant's **Overview** page in Studio. It has the format `graph-id@variant-name` (such as `my-graph@staging`).

3. Use the obtained values to set the following environment variables in your environment before starting up your router/server:

Expand Down
2 changes: 1 addition & 1 deletion src/content/shared/studio-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

| Page | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **README** | Displays the variant's editable Markdown-formatted README, its graph ref and router URL, and other important details about it. [Learn more.](/graphos/graphs/studio-features/#the-readme-page) |
| **Overview** | Displays the variant's editable Markdown-formatted README, its graph ref and router URL, and other important details about it. [Learn more.](/graphos/graphs/studio-features/#the-readme-page) |
| **Schema** | Documentation for all your supergraph's types and fields. Supports filtering definitions by name, subgraph, and other values. [Learn more.](/graphos/graphs/studio-features/#the-schema-page) |
| **Explorer** | A powerful IDE for building and executing operations against your supergraph. [Learn more.](/graphos/explorer/) |
| **Changelog** | Displays a historical diff of additions, modifications, and deletions made to your supergraph's schema. |
Expand Down

0 comments on commit 57c41a9

Please sign in to comment.