Skip to content

Commit b41e3a1

Browse files
committed
docs: clarify development feature flag documentation
The existing documentation for `features.rst` covered the API for managing GitLab's internal development feature flags, which requires administrator access. This was easily confused with the newly added project-level feature flags API. To prevent ambiguity for users, this commit refactors the documentation by: - Renaming `features.rst` to `gitlab_features.rst`. - Updating the title and adding a note to clarify its specific, admin-only purpose. - Adding a cross-reference to the new project-level feature flag documentation.
1 parent 14fcc91 commit b41e3a1

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docs/api-objects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ API examples
2424
gl_objects/environments
2525
gl_objects/events
2626
gl_objects/epics
27-
gl_objects/features
27+
gl_objects/gitlab_features
2828
gl_objects/geo_nodes
2929
gl_objects/groups
3030
gl_objects/group_access_tokens
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
##############
2-
Features flags
3-
##############
1+
################################
2+
GitLab Development Feature Flags
3+
################################
4+
5+
.. note::
6+
7+
This API is for managing GitLab's internal development feature flags and requires administrator access.
8+
For project-level feature flags, see :doc:`project_feature_flags`.
49

510
Reference
611
---------
@@ -11,7 +16,7 @@ Reference
1116
+ :class:`gitlab.v4.objects.FeatureManager`
1217
+ :attr:`gitlab.Gitlab.features`
1318

14-
* GitLab API: https://docs.gitlab.com/api/features
19+
* GitLab API: https://docs.gitlab.com/ee/api/features.html
1520

1621
Examples
1722
--------
@@ -29,4 +34,4 @@ Create or set a feature::
2934

3035
Delete a feature::
3136

32-
feature.delete()
37+
feature.delete()

0 commit comments

Comments
 (0)