Skip to content

Commit 95f2f29

Browse files
committed
docs: add new integration and CLI documentation, update links and references across various sections
1 parent 892a271 commit 95f2f29

63 files changed

Lines changed: 248 additions & 160 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/docs/administration-and-security/access-control/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Authentication
33
description: Customise how your users log in to the Flagsmith dashboard
44
sidebar_label: Overview
5-
sidebar_position: 1
5+
sidebar_position: 10
66
---
77

88
Flagsmith supports a variety of authentication methods for logging into the dashboard:

docs/docs/administration-and-security/access-control/rbac.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Role-based access control
33
sidebar_label: Role-based Access Control
4-
sidebar_position: 60
4+
sidebar_position: 1
55
---
66

77
:::info
@@ -17,7 +17,7 @@ For example, RBAC allows you to achieve the following scenarios:
1717

1818
- Only allow certain users to modify your production environments.
1919
- Grant a default set of permissions to all users that join your Flagsmith organisation.
20-
- Lock down an [Admin API](/flagsmith-integration/flagsmith-api-overview/admin-api) key to a specific set of permissions.
20+
- Lock down an [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) key to a specific set of permissions.
2121
- Provide Flagsmith permissions based on your enterprise identity provider's groups when using
2222
[SAML single sign-on](/administration-and-security/access-control/saml).
2323

@@ -51,7 +51,7 @@ following built-in roles:
5151
- _Organisation Administrator_ grants full access to everything in your Flagsmith organisation.
5252
- _User_ grants no access and requires you to assign permissions using custom roles and/or groups.
5353

54-
**Custom roles** can be assigned to users, groups or [Admin API](/flagsmith-integration/flagsmith-api-overview/admin-api) keys. Any
54+
**Custom roles** can be assigned to users, groups or [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) keys. Any
5555
number of custom roles can be created and assigned.
5656

5757
Creating, modifying or assigning roles requires organisation administrator permissions.

docs/docs/administration-and-security/billing-api-usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following screenshot shows an example usage graph from the Flagsmith dashboa
3131

3232
When your application is integrated with Flagsmith, it makes requests to the Flagsmith API to perform actions such as
3333
retrieving the current state of its flags. Some of these actions count towards your limit of billable API requests. The
34-
billable API requests that your application makes depend mainly on which [flag evaluation mode](/flagsmith-integration/integration-overview) it uses.
34+
billable API requests that your application makes depend mainly on which [flag evaluation mode](/integrating-with-flagsmith/integration-overview) it uses.
3535

3636
**Remote Evaluation** is the default for all applications. Applications using Remote Evaluation call the Flagsmith API
3737
when they need to fetch the flags for the current environment or user.
@@ -45,7 +45,7 @@ default) to fetch the flags for the current environment and all users in one API
4545

4646
The following requests are not billable:
4747

48-
- [Admin API](/flagsmith-integration/flagsmith-api-overview/admin-api) requests.
48+
- [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) requests.
4949
- Requests made by Flagsmith SDKs to track [Flag Analytics](/experimentation/flag-analytics).
5050
- Connecting to a [real-time flag updates](/performance/real-time-flags) stream.
5151

@@ -117,11 +117,11 @@ application. For example, when a user visits a certain part of your application
117117
a mobile application is brought to the foreground.
118118
* Consider using an Edge Proxy as your source of flags instead of calling the Flagsmith API directly.
119119
* If you have a suitable backend, consider evaluating flags server-side instead. This enables other usage patterns that
120-
result in fewer API calls, such as [Local Evaluation](/flagsmith-integration/integration-overview#local-evaluation-mode) and custom cache implementations.
120+
result in fewer API calls, such as [Local Evaluation](/integrating-with-flagsmith/integration-overview#local-evaluation-mode) and custom cache implementations.
121121

122122
For server-side applications:
123123

124-
* Consider using [Local Evaluation](/flagsmith-integration/integration-overview#local-evaluation-mode), or deploying [Edge Proxies](/performance/edge-proxy).
124+
* Consider using [Local Evaluation](/integrating-with-flagsmith/integration-overview#local-evaluation-mode), or deploying [Edge Proxies](/performance/edge-proxy).
125125
* Reduce the polling rate for Edge Proxies and any SDKs using Local Evaluation.
126126
* If your use case allows for it, use the Flagsmith SDK in Offline Mode.
127127

docs/docs/administration-and-security/data-management/import-and-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ There are several ways of importing or exporting Flagsmith data:
1717
between Flagsmith projects.
1818
* [Organisation import/export](organisations-import-export). Export an entire
1919
Flagsmith organisation and copy it to a different Flagsmith instance.
20-
* Use the [Admin API](/flagsmith-integration/flagsmith-api-overview/admin-api) to manually manage your Flagsmith data.
20+
* Use the [Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) to manually manage your Flagsmith data.
2121

2222
## Import from third-party services
2323

docs/docs/administration-and-security/governance-and-compliance/api-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Flagsmith will track API calls made by the SDKS and store them in its data-store
77
1. Get Flags
88
2. Get Identity Flags
99
3. Set Identity Traits
10-
4. Get [Environment Document](/flagsmith-integration/integration-overview) (for local evaluation SDKs)
10+
4. Get [Environment Document](/integrating-with-flagsmith/integration-overview) (for local evaluation SDKs)
1111

1212
![API Usage](/img/api-usage.png)
1313

docs/docs/administration-and-security/governance-and-compliance/custom-fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Custom fields are mainly intended to be read by humans visiting the Flagsmith da
6969

7070
Custom field values associated with features belong to the features themselves, and not an environment's feature state; you cannot override custom field values in different environments, segments or identities. They are not returned to applications that consume flags.
7171

72-
Custom field values are added directly to the `metadata` field of the entity they are defined in, which can be read using the [Flagsmith Admin API](/flagsmith-integration/flagsmith-api-overview/admin-api). For example, to fetch a feature's custom fields, use the [endpoint to fetch a feature by ID](https://api.flagsmith.com/api/v1/docs/#/api/api_v1_projects_features_read):
72+
Custom field values are added directly to the `metadata` field of the entity they are defined in, which can be read using the [Flagsmith Admin API](/integrating-with-flagsmith/flagsmith-api-overview/admin-api). For example, to fetch a feature's custom fields, use the [endpoint to fetch a feature by ID](https://api.flagsmith.com/api/v1/docs/#/api/api_v1_projects_features_read):
7373

7474
```shell
7575
curl "https://api.flagsmith.com/api/v1/projects/YOUR_PROJECT_ID/features/YOUR_FEATURE_ID/" \

docs/docs/administration-and-security/governance-and-compliance/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ There may be use-cases where you want to prevent client-side SDKs from setting t
1010
setting `plan=silver` as a trait, and then enabling/disabling features based on that plan, a malicious user could, with
1111
a client-side SDK, update their trait to `plan=gold` and unlock features they have not paid for.
1212

13-
You can prevent this by disabling the "Persist traits when using client-side SDK keys" option. This option defaults to "On". Turning it "Off" will not allow client-side SDKs to write traits to Flagsmith. In order to write traits, you will need to use a [server-side SDK and server-side Key](/flagsmith-integration/integration-overview).
13+
You can prevent this by disabling the "Persist traits when using client-side SDK keys" option. This option defaults to "On". Turning it "Off" will not allow client-side SDKs to write traits to Flagsmith. In order to write traits, you will need to use a [server-side SDK and server-side Key](/integrating-with-flagsmith/integration-overview).
1414

1515
This is a per-Environment setting.
1616

docs/docs/administration-and-security/governance-and-compliance/system-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ the end of your billing period.
7575

7676
### Admin API Rate Limit
7777

78-
Requests made to [Admin API endpoints](/flagsmith-integration/flagsmith-api-overview/admin-api) (i.e., non-SDK endpoints) are subject
78+
Requests made to [Admin API endpoints](/integrating-with-flagsmith/flagsmith-api-overview/admin-api) (i.e., non-SDK endpoints) are subject
7979
to a default rate limit of 500 requests per minute.
8080

8181
If you are self-hosting, you have the flexibility to modify this limit by adjusting the value of the environment

docs/docs/administration-and-security/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ Configure how users log in and what they can access within your Flagsmith organi
3333
<Card>
3434
<div className="card-header flex-column">
3535
<div className="icon-container">
36-
<IonIcon icon={key} className="card-icon" />
36+
<IonIcon icon={people} className="card-icon" />
3737
</div>
38-
<h3><Link to="/administration-and-security/access-control/">Authentication Management</Link></h3>
38+
<h3><Link to="/administration-and-security/access-control/rbac">User Management & Permissions</Link></h3>
3939
</div>
40-
<p>Set up authentication methods including SSO, SAML, LDAP, and 2FA</p>
40+
<p>Control user roles, groups, and fine-grained permissions</p>
4141
</Card>
4242

4343
<Card>
4444
<div className="card-header flex-column">
4545
<div className="icon-container">
46-
<IonIcon icon={people} className="card-icon" />
46+
<IonIcon icon={key} className="card-icon" />
4747
</div>
48-
<h3><Link to="/administration-and-security/access-control/rbac">User Management & Permissions</Link></h3>
48+
<h3><Link to="/administration-and-security/access-control/">Authentication Management</Link></h3>
4949
</div>
50-
<p>Control user roles, groups, and fine-grained permissions</p>
50+
<p>Set up authentication methods including SSO, SAML, LDAP, and 2FA</p>
5151
</Card>
5252

5353
<Card>

docs/docs/best-practices/defensive-coding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ So with that in mind, here are some rules you can follow to avoid any issues ste
2727

2828
The solution here really depends on which of our SDKs you are using. By default our Client SDKs will not block your main application thread, and are designed to work around an asynchronous callback model.
2929

30-
Where our Server Side SDKs are being used, it really depends on if you are using them in [local or remote evaluation mode](/flagsmith-integration/integration-overview). When running in local evaluation mode, once the SDKs have received a response from the API with the Environment related data, they will keep that data in memory. In the event of the SDKs then not receiving an update, they will continue to function.
30+
Where our Server Side SDKs are being used, it really depends on if you are using them in [local or remote evaluation mode](/integrating-with-flagsmith/integration-overview). When running in local evaluation mode, once the SDKs have received a response from the API with the Environment related data, they will keep that data in memory. In the event of the SDKs then not receiving an update, they will continue to function.
3131

3232
In the event that the SDKs aren't able to contact the API at all, they will time out and resort to [Default flags](#progressively-enhance-your-application-with-default-flags). When running in remote evaluation mode, you will need to decide what the best approach is based on your particular application. Again, [Default flags](#progressively-enhance-your-application-with-default-flags) can help here.
3333

@@ -57,7 +57,7 @@ In addition to this, by default our client-sde SDKs will only make a network cal
5757

5858
### Server side SDKs and local evaluation mode
5959

60-
If you need sub-millisecond latency for end-to-end flag evaluation, for example in the event that you are running a multi-variate test on a landing page of your website, you can employ one of our Server Side SDKs running in [local evaluation mode](/flagsmith-integration/integration-overview) mode. This will provide sub-millisecond latency of the entire flag evaluation rules engine, running locally within your server infrastructure, allowing you to run multivariate tests with zero latency impact.
60+
If you need sub-millisecond latency for end-to-end flag evaluation, for example in the event that you are running a multi-variate test on a landing page of your website, you can employ one of our Server Side SDKs running in [local evaluation mode](/integrating-with-flagsmith/integration-overview) mode. This will provide sub-millisecond latency of the entire flag evaluation rules engine, running locally within your server infrastructure, allowing you to run multivariate tests with zero latency impact.
6161

6262
### No proxy-server required
6363

0 commit comments

Comments
 (0)