Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilkisiela committed Oct 17, 2024
1 parent 01f0441 commit 045eda2
Show file tree
Hide file tree
Showing 20 changed files with 23 additions and 34 deletions.
3 changes: 1 addition & 2 deletions packages/web/app/src/pages/project-settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,9 @@ function ProjectSettingsPage_SlugForm(props: {
This is your project's URL namespace on Hive. Changing it{' '}
<span className="font-bold">will</span> invalidate any existing links to your project.
<br />
{/* TODO: document it */}
<DocsLink
className="text-muted-foreground text-sm"
href="/management/projects#change-slug-of-project"
href="/management/projects#change-slug-of-a-project"
>
You can read more about it in the documentation
</DocsLink>
Expand Down
3 changes: 1 addition & 2 deletions packages/web/app/src/pages/target-settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -824,10 +824,9 @@ function TargetSlug(props: { organizationId: string; projectId: string; targetId
<span className="font-bold">will</span> invalidate any existing links to your
target.
<br />
{/* TODO: document it */}
<DocsLink
className="text-muted-foreground text-sm"
href="/management/targets#change-slug-of-target"
href="/management/targets#change-slug-of-a-target"
>
You can read more about it in the documentation
</DocsLink>
Expand Down
Binary file modified packages/web/docs/public/docs/pages/first-steps/org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/web/docs/public/docs/pages/first-steps/project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/web/docs/public/docs/pages/first-steps/signup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
14 changes: 3 additions & 11 deletions packages/web/docs/src/pages/docs/management/organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Alternatively, you can create a new Hive organization by clicking on your user p
className="mt-8 max-w-sm rounded-lg drop-shadow-md"
/>

Follow the instructions and choose a name for your organization:
Follow the instructions and choose a unique slug for your organization:

<NextImage
alt="Create Organization Form"
Expand Down Expand Up @@ -200,20 +200,12 @@ for your needs. You can modify your plan and resevered quota any time during the
</Tabs.Tab>
</Tabs>

### Rename an organization

You can easily change the name of your organization in Hive by adjusting the settings of your
organization.

To do this, go to the **Settings** tab of your organization, and use the **Organization Name** form
to rename your organization.

### Change slug of organization

Slug is a unique identifier for your organization, and a URL namespace on GraphQL Hive.

Similarly to renaming an organization, you can change the slug of your organization by visiting
**Settings** tab of your organization, and using the **Organization Slug** form.
You can change the slug of your organization by visiting **Settings** tab of your organization, and
using the **Organization Slug** form.

<Callout type="warning">
Changing the slug of your organization will affect the organization URL, and will invalidate any
Expand Down
16 changes: 8 additions & 8 deletions packages/web/docs/src/pages/docs/management/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To create a new project, click on **Create Project +** button from your organiza
className="mt-10 max-w-lg rounded-lg drop-shadow-md"
/>

Choose a project type based on your project's stack, and then enter the project name.
Choose a project type based on your project's stack, and then enter the project slug.

<Callout>
Please note that a **project** type cannot be changed once it is created. However, you can always
Expand Down Expand Up @@ -74,16 +74,16 @@ Having a Project connected with your GitHub repositories gives you the following
className="mt-6 max-w-lg rounded-lg drop-shadow-md"
/>

### Rename a project
### Change slug of a project

You can easily change the name of your projects in Hive by adjusting the settings of your project.
Slug is a unique (within an organization) identifier for your project.

To do this, go to the **Settings** tab of your project, and use the **Project Name** form to rename
your project.
Similarly to changing organization's slug, you can change the slug of your organization by visiting
Settings tab of your project:

<Callout type="warning">
Changing the name of your project will also change the slug of your project URL, and will
invalidate any existing links to your project.
Changing the slug of your project will also change the URL, and will invalidate any existing links
to your project.
</Callout>

### Delete a project
Expand Down Expand Up @@ -202,7 +202,7 @@ From the **Alerts** tab of your project, you can create and manage your **Active
Notifications**.

To create a new kind of alert, use the **Create Alert** button and choose the **Alert type**,
**Alert Channel** and the target's name.
**Alert Channel** and the target's slug.

At the moment, Hive supports the following types of alerts and notifications (if you need a
different kind of alert, you can collaborate with us on
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ import azureAdEmail1 from '../../../../public/docs/pages/management/sso/azure-ad
import azureAdEmail2 from '../../../../public/docs/pages/management/sso/azure-ad-users-table.webp'
import oktaControlledImage from '../../../../public/docs/pages/management/sso/controlled-access-of-okta-app.webp'
import oktaAppIntegrationImage from '../../../../public/docs/pages/management/sso/create-new-app-integration-options.webp'
import hiveOidcModalImage from '../../../../public/docs/pages/management/sso/hive-connect-openid-provider-modal.webp'
import hiveOidcImage from '../../../../public/docs/pages/management/sso/hive-connect-openid-provider.webp'
import hiveManageOidcImage from '../../../../public/docs/pages/management/sso/hive-manage-openid-connect-modal.webp'
import hiveLoginUrlImage from '../../../../public/docs/pages/management/sso/hive-manage-openid-okta-login-url.webp'
import hiveOidcModalImage from '../../../../public/docs/pages/management/sso/hive-connect-openid-provider-modal.png'
import hiveOidcImage from '../../../../public/docs/pages/management/sso/hive-connect-openid-provider.png'
import hiveManageOidcImage from '../../../../public/docs/pages/management/sso/hive-manage-openid-connect-modal.png'
import hiveLoginUrlImage from '../../../../public/docs/pages/management/sso/hive-manage-openid-okta-login-url.png'
import oktaAdminButtonImage from '../../../../public/docs/pages/management/sso/okta-admin-button.webp'
import oktaAppConfigClientIdImage from '../../../../public/docs/pages/management/sso/okta-app-config-client-id.webp'
import oktaAppConfigClientSecretImage from '../../../../public/docs/pages/management/sso/okta-app-config-client-secret.webp'
Expand Down Expand Up @@ -216,7 +216,7 @@ you're done.

And congrats, you now have Okta connected! 🥳🎉

You can use the link provided in the modal right section to let your users login via Okta.
You can use the link provided in the modal left section to let your users login via Okta.

<NextImage
alt="Hive Login URL"
Expand Down
11 changes: 5 additions & 6 deletions packages/web/docs/src/pages/docs/management/targets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,15 @@ merged with your published schemas, before being checked and validated.

[You can find here the directive and scalar SDL needed for AWS AppSync](https://github.com/kamilkisiela/graphql-inspector/blob/d0efec031b64aae94818d749b697e73276f0f239/packages/loaders/loaders/src/index.ts#L57-L82)

### Rename a target
### Change slug of a target

You can easily change the name of your targets in Hive by adjusting the settings of your target.
You can easily change the slug of your targets in Hive by adjusting the settings of your target.

To do this, go to the **Settings** tab of your target, and use the **Target Name** form to rename
your target.
To do this, go to the **Settings** tab of your target, and use the **Target Slug** form.

<Callout type="warning">
Changing the name of your target will also change the slug of your target URL, and will invalidate
any existing links to your target.
Changing the slug of your target will also change the target's URL, and will invalidate any
existing links to your target.
</Callout>

### Delete a target
Expand Down

0 comments on commit 045eda2

Please sign in to comment.