Skip to content

Commit

Permalink
Made changes to user docs
Browse files Browse the repository at this point in the history
Made suggested changes to user management docs
  • Loading branch information
Kemi-Elizabeth committed Sep 20, 2024
1 parent 14ef40c commit 638e91a
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 53 deletions.
121 changes: 76 additions & 45 deletions sites/platform/.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ chrome-headless:
description: ''
disk: false
docs:
relationship_name: chromeheadlessbrowser
service_name: headlessbrowser
relationship_name: chrome-headless
service_name: chrome-headless
url: /add-services/headless-chrome.html
endpoint: http
min_disk_size: null
Expand Down Expand Up @@ -82,8 +82,8 @@ elasticsearch:
description: A manufacture service for Elasticsearch
disk: true
docs:
relationship_name: essearch
service_name: searchelastic
relationship_name: elasticsearch
service_name: elasticsearch
url: /add-services/elasticsearch.html
endpoint: elasticsearch
min_disk_size: 256
Expand Down Expand Up @@ -216,14 +216,16 @@ golang:
- '1.9'
- '1.8'
supported:
- '1.23'
- '1.22'
- '1.21'
- '1.20'
influxdb:
description: ''
disk: true
docs:
relationship_name: influxtimedb
service_name: timedb
relationship_name: influxdb
service_name: influxdb
url: /add-services/influxdb.html
endpoint: influxdb
min_disk_size: null
Expand Down Expand Up @@ -284,8 +286,8 @@ kafka:
description: ''
disk: true
docs:
relationship_name: kafkaqueue
service_name: queuekafka
relationship_name: kafka
service_name: kafka
url: /add-services/kafka.html
endpoint: kafka
min_disk_size: 512
Expand All @@ -303,8 +305,10 @@ kafka:
- '2.2'
- '2.1'
supported:
- '3.2'
- '3.7'
- '3.6'
- '3.4'
- '3.2'
legacy:
- '2.6'
- '2.5'
Expand Down Expand Up @@ -344,8 +348,8 @@ mariadb:
repo_name: mariadb
disk: true
docs:
relationship_name: database
service_name: db
relationship_name: mariadb
service_name: mariadb
url: /add-services/mysql.html
endpoint: mysql
min_disk_size: 256
Expand All @@ -360,6 +364,7 @@ mariadb:
- '10.0'
- '5.5'
supported:
- '11.4'
- '11.2'
- '11.0'
- '10.11'
Expand All @@ -368,6 +373,7 @@ mariadb:
- '10.4'
versions-dedicated-gen-2:
supported:
- 10.11 Galera
- 10.8 Galera
- 10.7 Galera
- 10.6 Galera
Expand All @@ -393,8 +399,8 @@ mysql:
repo_name: mariadb
disk: true
docs:
relationship_name: database
service_name: db
relationship_name: mysql
service_name: mysql
url: /add-services/mysql.html
endpoint: mysql
min_disk_size: 256
Expand Down Expand Up @@ -438,8 +444,8 @@ memcached:
repo_name: memcached
disk: false
docs:
relationship_name: memcachedcache
service_name: cachemc
relationship_name: memcached
service_name: memcached
url: /add-services/memcached.html
endpoint: memcached
min_disk_size: null
Expand All @@ -460,8 +466,8 @@ mongodb:
repo_name: mongodb
disk: true
docs:
relationship_name: mongodatabase
service_name: dbmongo
relationship_name: mongodb
service_name: mongodb
url: /add-services/mongodb.html
endpoint: mongodb
min_disk_size: 512
Expand All @@ -481,8 +487,8 @@ mongodb-enterprise:
repo_name: mongodb
disk: true
docs:
relationship_name: mongodatabase
service_name: dbmongo
relationship_name: mongodb-enterprise
service_name: mongodb-enterprise
url: /add-services/mongodb.html
endpoint: mongodb
min_disk_size: 512
Expand All @@ -492,19 +498,20 @@ mongodb-enterprise:
premium: true
versions:
supported:
- '7.0'
- '6.0'
- '5.0'
- '4.4'
- '4.2'
deprecated:
- '4.2'
- '4.0'
versions-dedicated-gen-2:
supported:
- '6.0'
- '5.0'
- '4.4'
- '4.2'
deprecated:
- '4.2'
- '4.0'
network-storage:
description: ''
Expand Down Expand Up @@ -569,8 +576,8 @@ opensearch:
description: A manufacture service for OpenSearch
disk: true
docs:
relationship_name: ossearch
service_name: searchopen
relationship_name: opensearch
service_name: opensearch
url: /add-services/opensearch.html
endpoint: opensearch
min_disk_size: 256
Expand Down Expand Up @@ -603,8 +610,8 @@ oracle-mysql:
repo_name: oracle-mysql
disk: true
docs:
relationship_name: mysqldatabase
service_name: dbmysql
relationship_name: oracle-mysql
service_name: oracle-mysql
url: /add-services/mysql.html
endpoint: mysql
min_disk_size: 256
Expand Down Expand Up @@ -674,8 +681,8 @@ postgresql:
repo_name: postgresql
disk: true
docs:
relationship_name: postgresdatabase
service_name: dbpostgres
relationship_name: postgresql
service_name: postgresql
url: /add-services/postgresql.html
endpoint: postgresql
min_disk_size: null
Expand Down Expand Up @@ -754,8 +761,8 @@ rabbitmq:
repo_name: rabbitmq
disk: true
docs:
relationship_name: rabbitmqqueue
service_name: queuerabbit
relationship_name: rabbitmq
service_name: rabbitmq
url: /add-services/rabbitmq.html
endpoint: rabbitmq
min_disk_size: 512
Expand All @@ -764,42 +771,46 @@ rabbitmq:
type: rabbitmq
versions:
deprecated:
- '3.11'
- '3.10'
- '3.9'
- '3.8'
- '3.7'
- '3.6'
- '3.5'
supported:
- '3.13'
- '3.12'
- '3.11'
- '3.10'
- '3.9'
legacy:
- '3.8'
- '3.7'
- '3.6'
- '3.5'
versions-dedicated-gen-2:
supported:
- '3.13'
- '3.12'
deprecated:
- '3.11'
- '3.10'
- '3.9'
deprecated:
- '3.8'
- '3.7'
versions-dedicated-gen-3:
deprecated: []
supported:
- '3.12'
deprecated:
- '3.11'
- '3.10'
- '3.9'
supported:
- '3.13'
- '3.12'
redis:
description: 'A manufacture-based Redis container '
repo_name: redis
disk: false
docs:
relationship_name: rediscache
service_name: cacheredis
relationship_name: redis
service_name: redis
url: /add-services/redis.html
endpoint: redis
min_disk_size: null
Expand Down Expand Up @@ -889,6 +900,24 @@ ruby:
- '2.5'
- '2.4'
- '2.3'
versions-dedicated-gen-3:
deprecated:
- '2.7'
- '2.6'
- '2.5'
- '2.4'
- '2.3'
supported:
- '3.3'
- '3.2'
- '3.1'
- '3.0'
legacy:
- '2.7'
- '2.6'
- '2.5'
- '2.4'
- '2.3'
rust:
description: ''
repo_name: rust
Expand All @@ -914,8 +943,8 @@ solr:
repo_name: solr
disk: true
docs:
relationship_name: solrsearch
service_name: searchsolr
relationship_name: solr
service_name: solr
url: /add-services/solr.html
endpoint: solr
min_disk_size: 256
Expand All @@ -934,6 +963,7 @@ solr:
- '4.10'
- '3.6'
supported:
- '9.4'
- '9.2'
- '9.1'
- '8.11'
Expand All @@ -958,7 +988,7 @@ varnish:
repo_name: varnish
disk: false
docs:
relationship_name: varnishstats
relationship_name: varnish
service_name: varnish
url: /add-services/varnish.html
endpoint: http+stats
Expand All @@ -974,19 +1004,20 @@ varnish:
type: varnish
versions:
deprecated:
- '5.2'
- '5.1'
- '5.2'
- '6.3'
- '6.4'
- '7.1'
- '6.0'
supported:
- '7.3'
- '7.2'
- '6.3'
- '6.0'
vault-kms:
description: ''
disk: true
docs:
relationship_name: vault_service
relationship_name: vault-kms
service_name: vault-kms
url: /add-services/vault.html
endpoint: manage_keys
Expand Down
2 changes: 1 addition & 1 deletion sites/upsun/src/administration/mfa.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To enable MFA on your user account, follow these steps:
{{< note theme="info" title="Feature availability and permissions">}}

This feature is available as part of the Standard User Management add-on.
To add it to your project, [administer your organization's billing](/administration/billing/billing-admin).
To add it to your organization, [administer your organization's billing](/administration/billing/billing-admin).

Only **organization owners** and **admin users** can enable MFA within an organization.
However, even if you have the required permissions,
Expand Down
8 changes: 2 additions & 6 deletions sites/upsun/src/administration/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ For more information on project access control, see how to [manage project users

### Organization permissions

{{< partial "user-mgt-sellable/body.md" >}}

As an organization owner or an organization user with the **Manage users** permission,
you can invite other users to your organization and grant them the following permissions:

Expand Down Expand Up @@ -263,12 +265,6 @@ Their permission level can't be edited.
Organization owners can't be removed from their organization,
except through an [ownership transfer](../administration/organizations.md#transfer-project-ownership).

{{< note title="Available add-on" >}}

To be able to create custom organization permissions, [upgrade to the Standard User Management add-on](administration/billing/add-on-subscription.md#standard-user-management-add-on).

{{< /note >}}

### Add a user to an organization

{{< codetabs >}}
Expand Down
2 changes: 1 addition & 1 deletion themes/psh-docs/layouts/partials/user-mgt-sellable/body.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{ $content := `This feature is available as part of the Standard User Management add-on.
To add it to your project, [administer your organization's billing](/administration/billing/billing-admin).`}}
To enable it on your organization, [administer your organization's billing](/administration/billing/billing-admin).`}}

{{ partial "premium-features/banner" ( dict "context" . "content" $content "title" "Feature Availability" )}}

0 comments on commit 638e91a

Please sign in to comment.