fix: URLs to images in docs (#17022)

This commit is contained in:
Keith Williams
2024-10-09 11:48:26 +00:00
committed by GitHub
parent ed53645783
commit 1a4cf5f91d
9 changed files with 34 additions and 34 deletions
@@ -74,7 +74,7 @@ title: "Build a greeter app"
<GreeterButton />;
```
<img src="./images/i1280x250-dXnl-QuzSMbl_xydd9y.png" />
<img src="/images/i1280x250-dXnl-QuzSMbl_xydd9y.png" />
A sample line where I used the component in the demo
@@ -92,4 +92,4 @@ title: "Build a greeter app"
</Step>
</Steps>
That's it. You now have a fully functional Greeter app. This is the simplest possible demonstration of how you can build an app and what it can do. There are simply no restrictions on what an app can achieve.
That's it. You now have a fully functional Greeter app. This is the simplest possible demonstration of how you can build an app and what it can do. There are simply no restrictions on what an app can achieve.
@@ -21,7 +21,7 @@ You just need to provide a few inputs and then you will have your app created wi
</Step>
<Step title="Adding the functionalities">
There is pretty much no restriction on what an App can do. For example:
- Hooking into existing functionalities to enhance them - _In all these cases you need to first check if the app is installed or not. There is_ `_useApp(appSlug)_` _react hook to do that. It gives you the app details if the app is installed._
- Apps that need to connect with third parties like Google Calendar, Apple Calendar, Google Meet.
- A very powerful app that has its own data and pages - [Routing Forms App](https://github.com/calcom/cal.com/tree/main/packages/app-store/ee/routing_forms) is a great example of this.
@@ -71,7 +71,7 @@ yarn app-store edit --slug APP_NAME
* If app-store cli fails at this step, try to run this command manually first. Solve that problem and then re-run cli. The command can fail because there are Prisma migrations that can't be applied automatically.
<img src="./images/i1600x120-WfEdMhsOOLSg_sitk6a.png" />
<img src="/images/i1600x120-WfEdMhsOOLSg_sitk6a.png" />
A sample failure in create command
@@ -83,4 +83,4 @@ A sample failure in create command
Once your app is working in your environment, you can publish it to Cal.com App Store by opening a PR [here](https://github.com/calcom/cal.com).
If you need any help feel free to join us on [Discord](https://go.cal.com/discord).
If you need any help feel free to join us on [Discord](https://go.cal.com/discord).
@@ -5,13 +5,13 @@ title: "Setting up OIDC with okta"
<Steps>
<Step title="Create an application with your OIDC provider">
For example, in Okta, once you create an account, you can click on Applications on the sidebar menu:
<img src="./images/i1600x900-oVjaQ0tU3AnO_wrzp85.png" />
<img src="/images/i1600x900-oVjaQ0tU3AnO_wrzp85.png" />
</Step>
<Step title="Click on Create App Integration">
<img src="./images/i1600x900-wrIlZkLdZ6kL_wf7mxn.png" />
<img src="/images/i1600x900-wrIlZkLdZ6kL_wf7mxn.png" />
</Step>
<Step title="Select OIDC in the modal form, along with Web App, and click Next">
<img src="./images/i1600x900-IfRWYg8XuCMI_tkwyft.png" />
<img src="/images/i1600x900-IfRWYg8XuCMI_tkwyft.png" />
</Step>
<Step title="Enter the Sign in redirect URL and sign out URL">
Enter the Sign in redirect URL (or auth URL) as:
@@ -22,7 +22,7 @@ title: "Setting up OIDC with okta"
```
https://app.cal.com/auth/login
```
<img src="./images/i1600x900-TqgDJpBoiR-C_onrwit.png" />
<img src="/images/i1600x900-TqgDJpBoiR-C_onrwit.png" />
</Step>
<Step title="Gather Client Secret, Client ID, and Well Known URL">
Now you should have the Client Secret and Client ID with you. You would also need the Well Known URL which for Okta is generally of the type:
@@ -39,11 +39,11 @@ title: "Setting up OIDC with okta"
</Step>
<Step title="Go to Organization SSO Settings">
Visit `https://app.cal.com/settings/organizations/sso` and you should see something like this:
<img src="./images/i1600x900-8ufcUyCOVwV6_hdudno.png" />
<img src="/images/i1600x900-8ufcUyCOVwV6_hdudno.png" />
</Step>
<Step title="Configure SSO with OIDC">
Click on Configure SSO with OIDC, and then enter the Client Secret, Client ID, and Well Known URL from Step 5, and click save.
<img src="./images/i1600x900-GN1NLgrcf5r4_tmhni3.png" />
<img src="/images/i1600x900-GN1NLgrcf5r4_tmhni3.png" />
</Step>
</Steps>
@@ -1,35 +1,35 @@
<Steps>
<Step title="Create an application with your OIDC provider">
For example, in Okta, once you create an account, you can click on Applications on the sidebar menu:
<img src="./images/i1600x900-oVjaQ0tU3AnO_wrzp85.png" />
<img src="/images/i1600x900-oVjaQ0tU3AnO_wrzp85.png" />
</Step>
<Step title="Click on Create App Integration">
<img src="./images/i1600x900-wrIlZkLdZ6kL_wf7mxn.png" />
<img src="/images/i1600x900-wrIlZkLdZ6kL_wf7mxn.png" />
</Step>
<Step title="Select SAML or OIDC and Web App, then click Next">
Note you will have to fill in the appropriate fields for the SAML or OIDC setup to continue.
- [SAML Setup](/developing/guides/auth-and-provision/sso-setup#setting-up-saml-login)
- [OIDC Setup](/developing/guides/auth-and-provision/sso-setup#setting-up-oidc-login)
<img src="./images/i1600x900-IfRWYg8XuCMI_tkwyft.png" />
<img src="/images/i1600x900-IfRWYg8XuCMI_tkwyft.png" />
</Step>
<Step title="Enable SCIM provisioning">
Once the application is created, under General -> App Settings, click "Edit" and then the checkbox "Enable SCIM provisioning".
<img src="./images/scim/app-settings-enable-scim.webp" />
<img src="/images/scim/app-settings-enable-scim.webp" />
</Step>
<Step title="Go to Directory Sync in Cal.com">
Next, go to your instance of Cal.com and navigate to `https://app.cal.com/settings/organization/dsync` and click configure.
<img src="./images/scim/dsync-configure.webp" />
<img src="/images/scim/dsync-configure.webp" />
</Step>
<Step title="Configure Directory Sync">
In the "Configure Directory Sync" form, choose a directory sync name and select "Okta SCIM v2.0" as the "Directory Provider".
<img src="./images/scim/dsync-configure-provider.webp" />
<img src="/images/scim/dsync-configure-provider.webp" />
</Step>
<Step title="Take note of SCIM Base URL and SCIM Bearer Token">
<img src="./images/scim/dsync-configure-info.webp" />
<img src="/images/scim/dsync-configure-info.webp" />
</Step>
<Step title="Setup Provisioning in Okta">
In Okta, go to your application. Navigate to the "Provisioning" tab and click "Integration" under "Settings".
<img src="./images/scim/okta-dsync-options.webp" />
<img src="/images/scim/okta-dsync-options.webp" />
- Under "SCIM connector base URL" enter the "SCIM Base URL" from Cal.com
- Under "Unique identifier field for users" enter "email"
- Under "Supported provisioning actions" enable:
@@ -60,7 +60,7 @@
</Step>
<Step title="Map Attributes from Okta Profile">
Set each of these properties to "Map from Okta Profile" and the related field. Under "Apply On" select "Create and Update".
<img src="./images/scim/okta-property-settings.webp" />
<img src="/images/scim/okta-property-settings.webp" />
</Step>
<Step title="Assign users and groups to the app">
You can now assign users and groups to the app.
@@ -79,4 +79,4 @@ The group name must be spelled exactly as it is shown on Okta.
When you push the group to your organization, those users will automatically be added to the team.
<img src="./images/scim/group-team-mapping.webp" />
<img src="/images/scim/group-team-mapping.webp" />
@@ -63,11 +63,11 @@ This guide explains the settings you need to use to configure SAML with your Ide
</Step>
<Step title="Log in and go to Organization SSO Settings">
Visit `/settings/organizations/sso` and you should see something like this:
<img src="./images/i1600x900-8ufcUyCOVwV6_hdudno.png" />
<img src="/images/i1600x900-8ufcUyCOVwV6_hdudno.png" />
</Step>
<Step title="Configure SSO with OIDC">
Click on Configure SSO with OIDC, enter the Client Secret, Client ID, and Well Known URL from Step 1, and click save.
<img src="./images/i1600x900-GN1NLgrcf5r4_tmhni3.png" />
<img src="/images/i1600x900-GN1NLgrcf5r4_tmhni3.png" />
</Step>
<Step title="Complete OIDC setup">
Now, when you try to login with SSO, your OIDC provider will handle the authentication.
+1 -1
View File
@@ -3,7 +3,7 @@ title: "Introduction"
icon: "presentation-screen"
---
<img src="./images/i1440x910-pNoAmSPnktzZ_ecaypm.png" />
<img src="/images/i1440x910-pNoAmSPnktzZ_ecaypm.png" />
<CardGroup cols={2}>
+1 -1
View File
@@ -103,7 +103,7 @@ yarn playwright show-report test-results/reports/playwright-html-report
<Info>
When you're testing out the enterprise features locally, you should see a warning shown in the image below, clarifying the need to purchase a license for such features in production.
<img src="./images/i1600x900-E4RcIPb1_bYp_hcpsya.png" />
<img src="/images/i1600x900-E4RcIPb1_bYp_hcpsya.png" />
</Info>
@@ -7,14 +7,14 @@ Contributions are what make the open source community such an amazing place to l
- Before jumping into a PR be sure to search [existing PRs](https://github.com/calcom/cal.com/pulls) or [issues](https://github.com/calcom/cal.com/issues) for an open or closed item that relates to your submission.
### Priorities
### Priorities
| Type of issue | Priority |
| :-------------------------------------------------------------- | :-------------------------------------------------- |
| Minor improvements, non-core feature requests | <img className="m-0" noZoom src="./images/low-priority.svg" /> |
| Confusing UX (... but working) | <img className="m-0" noZoom src="./images/medium-priority.svg" /> |
| Core Features (Booking page, availabilty, timezone calculation) | <img className="m-0" noZoom src="./images/high-priority.svg" /> |
| Core Bugs (Login, Booking page, Emails are not working) | <img className="m-0" noZoom src="./images/urgent-priority.svg" /> |
| Minor improvements, non-core feature requests | <img className="m-0" noZoom src="/images/low-priority.svg" /> |
| Confusing UX (... but working) | <img className="m-0" noZoom src="/images/medium-priority.svg" /> |
| Core Features (Booking page, availabilty, timezone calculation) | <img className="m-0" noZoom src="/images/high-priority.svg" /> |
| Core Bugs (Login, Booking page, Emails are not working) | <img className="m-0" noZoom src="/images/urgent-priority.svg" /> |
### Developing
@@ -134,4 +134,4 @@ If `yarn.lock` was committed a while ago and there have been several commits sin
- Then push the updated branch:
```git
git push origin <your-branch-name>
```
```