Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 81223e7

Browse files
committed
Edits permissions and roles page.
1 parent fada38c commit 81223e7

32 files changed

+2471
-3
lines changed

docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,60 @@
11
= Permissions and roles
22

3+
== Getting started
4+
5+
When the administrators at {ProductName} create a workspace for you, you automatically have the role of *Admin*.
6+
7+
== Types of roles
8+
39
The following list shows the three roles that are available in a workspace:
410

511
* *Contributor*: Ideal for users who actively push to your workspace
612
* *Maintainer*: Ideal for users who need to manage the workspace, but who don't need access to sensitive actions like managing security or deleting a workspace
7-
* *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace
13+
* *Admin*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace
14+
15+
== Adding or changing users
816

9-
== Adding a user
1017
We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a Slack message in the https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request.
1118

1219
Or, send a message in the chat feature in the {ProductName} application.
1320

21+
////
22+
23+
To begin adding, editing, or removing users from a workspace, complete the following steps:
24+
. In the side bar, select *Workspaces*.
25+
. Select the tab *Access*.
26+
27+
=== Adding a user to a workspace
28+
29+
. In *Find by username*, enter the users that you want to grant access to.
30+
* Optionally, change *Username* to the search option of your choice.
31+
. Select *Grant Access*.
32+
. In *Assign role*, select either *Contributor*, *Maintainer*, or *Admin*.
33+
* To view the permissions for each role, select *Show list*.
34+
. Select *Save*.
35+
36+
=== Removing a user from a workspace
37+
. Select the three dots next to the user that you want to remove.
38+
. Select *Remove access*.
39+
. To confirm, select *Remove*.
40+
41+
=== Editing the access of a user
42+
. Select the three dots next to the user that you want to edit.
43+
. Select *Edit access*.
44+
. In *Assign roles*, change the drop-down to the new role that you want.
45+
* To view the permissions for each role, select *Show list*.
46+
. Select *Save changes*.
47+
48+
////
49+
1450
== Permissions by role
1551

1652
The following table shows the actions that each type of collaborator can perform:
1753

1854
.Permissions for each type of collaborator
1955

2056
|===
21-
|Action |Contributor |Maintainer |Owner
57+
|Action |Contributor |Maintainer |Admin
2258

2359
|*Workspace:*
2460

styles/RedHat/Abbreviations.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
extends: existence
3+
level: error
4+
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/
5+
message: "Do not use periods in all-uppercase abbreviations such as '%s'."
6+
nonword: true
7+
source: "IBM - Periods with abbreviations, p. 5"
8+
tokens:
9+
- '\b(?:[A-Z]\.){3,5}'
Lines changed: 297 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,297 @@
1+
---
2+
extends: substitution
3+
ignorecase: false
4+
level: error
5+
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/
6+
message: Use '%s' rather than '%s'.
7+
source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions"
8+
action:
9+
name: replace
10+
swap:
11+
"(?<!/)var": VAR
12+
# Bind: BIND
13+
'(?<!\.)yaml|Yaml': YAML
14+
'(?<!Business )Resource Planner|(?<!Business Resource )Planner': Business Resource Planner
15+
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
16+
'(?<!Microsoft )Azure': Microsoft Azure
17+
'(?<!Microsoft Azure )On-Demand Marketplace': Microsoft Azure On-Demand Marketplace
18+
'(?<!Realtime )Decision\sServer': Realtime Decision Server
19+
'(?<!Red Hat )Customer Portal': Red Hat Customer Portal
20+
'(?<!Red Hat )JBoss Enterprise Application Platform': Red Hat JBoss Enterprise Application Platform
21+
'(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP': Red Hat OpenStack Platform
22+
'(?<!Red Hat JBoss )BRMS(?! engine)': inference engine
23+
'(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS': Red Hat JBoss BRMS
24+
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
25+
'\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': .NET
26+
'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
27+
'A-MQ\sBroker': AMQ Broker
28+
'A-MQ\sClients': AMQ Clients
29+
'A-MQ\sConsole': AMQ Console
30+
'A-MQ\sInterconnect': AMQ Interconnect
31+
'ack\spacket|ACK(?!\sflag)|ack': ACK flag
32+
'ActiveMQ\sArtemis|ActiveMQ(?!\sArtemis)': built-in messaging|JBoss EAP built-in messaging|JBoss EAP messaging
33+
'Admin\sPortal|webadmin\sportal|webadmin|Administrator\sPortal|Administration\sportal': Administration Portal
34+
'BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)': Red Hat JBoss BPM Suite
35+
'BRMS\sengine': inference engine
36+
'DM(?![ -]Multipath)|directory manager': Directory Manager
37+
'GUI\seditor|Business\sCentral\seditor': guided editor
38+
'JBoss Broker|Red Hat Broker|The AMQ Broker': AMQ Broker
39+
'JBoss Console|Red Hat Console': AMQ Console
40+
'JBoss\.org': JBoss Community
41+
'JBoss\sAMQ': AMQ
42+
'JBoss\sInterconnect': AMQ Interconnect
43+
'Kernel(?!-based Virtual Machine)': kernel
44+
'Kie(?!\sServer)': KIE
45+
'Kie\sServer': Intelligent Process Server
46+
'O\.K\.D|okd|OpenShift Kubernetes Distribution|OpenShift\sOrigin': OKD
47+
'OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager': Red Hat OpenShift Cluster Manager
48+
'OD': Red Hat OpenShift Dedicated
49+
'Red\sHat\sInterconnect': AMQ Interconnect
50+
'Red\sHat\sVirtualization\sHypervisor|RHV\sHost|RHV-H': Red Hat Virtualization Host
51+
'RHVM|RHV-M|RHV\sManager': Red Hat Virtualization Manager
52+
'self-hosted\sengine\svirtual\smachine|engine\sVM': Manager virtual machine
53+
Appliance Console: Appliance console
54+
Applix|ApplixWare: Applixware
55+
asciidoctor|AsciiDoctor: Asciidoctor
56+
asciidoc|Asciidoc: AsciiDoc
57+
assertj|Assertj: AssertJ
58+
auto-link|AutoLink: autolink
59+
basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication (first instance)|Basic authentication
60+
BC: Business Central
61+
Bios: BIOS
62+
blue print|BluePrint: blueprint
63+
bluestore|Blue Store: BlueStore
64+
btrfs: Btrfs
65+
Capex|capex|capEx: CapEx
66+
Capsule server: Capsule Server
67+
CD 1: CD #1
68+
CDS|Cds: CDs
69+
Ceph Ansible: ceph-ansible
70+
Ceph block device|Ceph block devices: Ceph Block Device
71+
Ceph filesystem|Ceph file system: Ceph File System
72+
Ceph monitor: Ceph Monitor
73+
Ceph object gateway|Ceph object gateways: Ceph Object Gateway
74+
ceph-osd|Object Storage Device|OSD daemon: OSD
75+
cephfs: CephFS
76+
CGroup|c group: cgroup
77+
cidr|Classless Interdomain Routing|Classless Inter-domain Routing: CIDR
78+
classic mode: GNOME Classic
79+
CloudForms Management Engine|CFME: Red Hat CloudForms|Red Hat CloudForms Appliance
80+
command prompt: shell prompt|Command Prompt (Windows product)
81+
Composite Content view|composite content view|Composite View|composite view: Composite Content View
82+
configmap: config map
83+
configuration map: config map
84+
Content view|content view: Content View
85+
control key|ctrl: Ctrl
86+
crush map|crushmap: CRUSH map
87+
csv: CSV
88+
CygMon|cygmon|CYGMON: Cygmon
89+
Data Grid Administration Console: Data Grid Console
90+
Data Grid console: Data Grid Console
91+
Denial of Service: denial of service
92+
Denial-of-Service: denial-of-service
93+
Development Preview|Developer preview|dev preview: Developer Preview
94+
devops|Devops|Dev-Ops|Dev Ops: DevOps
95+
directory server: Directory Server
96+
Disk druid|disk druid|diskdruid: Disk Druid
97+
dns: DNS
98+
DVD burner|burner: DVD writer
99+
DWH|data warehouse|Dataware House: Data Warehouse
100+
Etcd|ETCD: etcd
101+
Exec Shield: Exec-Shield
102+
EXIF|exif: Exif
103+
Extranet: extranet
104+
facter: Facter
105+
Faq|faq|F.A.Q: FAQ
106+
fault tolerant: fault-tolerant
107+
fault-tolerance: fault tolerance
108+
fedora project: Fedora™ Project
109+
filestore|File Store: FileStore
110+
Firewalld|firewallD|FirewallD: firewalld
111+
Firewire|firewire: FireWire
112+
FlatHub: Flathub
113+
FlatPak: Flatpak
114+
fortran: Fortran
115+
Fqdn|fqdn: FQDN
116+
gbps|GBPS: Gbps
117+
gb|Gb: GB
118+
GDBTK: Insight
119+
gid|Gid: GID
120+
Gimp|gimp: GIMP
121+
git|GIT: Git
122+
Gnome|gnome: GNOME
123+
Gnu|gnu: GNU
124+
Gpl|gpl: GPL
125+
Graalvm|graalVM: GraalVM
126+
Greenboot|green boots: greenboot
127+
Grub: GRUB
128+
GTK|Gtk|gtk: GTK+
129+
hot rod|HotRod|hotrod: Hot Rod
130+
HP Proliant: HP ProLiant
131+
HTTP interface: management console
132+
hyperthreading|hyper-threading: Hyper-Threading
133+
HyperVisor|Hyperviser: hypervisor
134+
IA64|ia64: Itanium
135+
IBM z Systems: IBM Z
136+
Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
137+
ignition config: Ignition config
138+
Image Builder: image builder
139+
INSTALL_DIR|installDir: FUSE_HOME
140+
Iops|IOPs: IOPS
141+
Ip: IP
142+
IPSec: IPsec
143+
ipv4|IPV4|Ipv4: IPv4
144+
ipv6|IPV6|Ipv6: IPv6
145+
iSeries: ISeries
146+
iso: ISO
147+
Itanium2: Itanium 2
148+
jar file: JAR file
149+
JBoss Clients: AMQ Clients
150+
JBoss Data Grid: Data Grid
151+
jetbrains|Jetbrains: JetBrains
152+
Junit|junit: JUnit
153+
Jvm|jvm: JVM
154+
kbase|knowledge base: KIE base
155+
kernel-based virtual machine: Kernel-based Virtual Machine
156+
kernelspace: kernel space
157+
key store: keystore
158+
kickstart: Kickstart
159+
kie API|Kie API|knowledge API: KIE API
160+
kjar|kJAR: KJAR
161+
knowledgebase: Knowledgebase
162+
ksession|knowledge session: KIE session
163+
Kubelet: kubelet
164+
kubernetes|k8s: Kubernetes
165+
kvm: KVM
166+
Lan|lan: LAN
167+
Librados|LIBRADOS: librados
168+
Librbd|LIBRBD: librbd
169+
Lightweight Directory Access Protocol over Secure Socket Layer: LDAPS
170+
LINUX|linux: Linux
171+
live-backup group: master-slave group
172+
Lun|lun: LUN
173+
master CA: IdM CA renewal server
174+
master server: IdM server and replicas
175+
Microprofile|micro-profile: MicroProfile
176+
Microsoft Azure Portal: Microsoft Azure portal
177+
Microsoft Windows Server: Windows Server
178+
MoM|Mom|mom: MOM
179+
Mongo\sDB|mongoDB|Mongodb|Mongo-db: MongoDB
180+
MS(?!-DOS?)|MSFT|MicroSoft: Microsoft
181+
MS-dos|Ms-Dos|ms-dos|MSDOS|msdos: MS-DOS
182+
MTLS|m-TLS: mTLS
183+
mutual tls|Mutual tls|Mutual TLS: mutual TLS
184+
MYSQL|mySQL: MySQL
185+
native interface: management CLI
186+
network interface card: network interface controller (NIC)
187+
objectclass: objectClass
188+
Objective-C: Objective C
189+
OCP: Red Hat OpenShift Container Platform
190+
ODF: Red Hat OpenShift Data Foundation
191+
Open InfiniBand|Infiniband: InfiniBand
192+
openid connect|Openid Connect: OpenID Connect
193+
Openshift online|OO: Red Hat OpenShift Online
194+
Operating Environment: operating environment
195+
Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
196+
Opex|Opex|OPEX|opEx: OpEx
197+
Organization administrator|Org Admin|org admin: Organization Administrator
198+
OS|Operating System: operating system
199+
Overcloud: overcloud
200+
Podman desktop: Podman Desktop
201+
podman: Podman
202+
popup|Pop-up: pop-up
203+
Posix|posix: POSIX
204+
Postscript: PostScript
205+
Powershell|powershell: PowerShell
206+
PPC|P-PC|PPC64: PowerPC
207+
Ppp|ppp: PPP
208+
prom|Prom: PROM
209+
proof key for code exchange: Proof Key for Code Exchange
210+
proof of concepts: proofs of concept
211+
Properties editor: Properties View
212+
pSeries: IBM eServer System p
213+
puppet forge: Puppet Forge
214+
puppet: Puppet
215+
q & a|q&a|Q & A|Q&A: Q and A
216+
qcow2|Qcow2: QCOW2
217+
Qdmanage|QDMANAGE: qdmanage
218+
Qdstat|QDSTAT: qdstat
219+
Qeth|QETH: qeth
220+
RAMdisk|ramdisk|RAM-disk: RAM disk
221+
Ram|ram: RAM
222+
RAW: raw
223+
Red Hat JBoss Data Grid|JDG: Red Hat Data Grid
224+
Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
225+
Red Hat Network Satellite server: Red Hat Network Satellite Server
226+
Red Hat Proxy: Red Hat Network Proxy Server
227+
Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server
228+
Red Hat Satellite server: Red Hat Satellite Server
229+
Red Hat satellite: Red Hat Satellite
230+
Redboot|Red Boot: RedBoot
231+
redis: Redis
232+
RESTEASY|resteasy|Resteasy: RESTEasy
233+
RHDS: Red Hat Directory Server
234+
RHEL host|RHEL-H: Red Hat Enterprise Linux host
235+
RHV: Red Hat Virtualization
236+
Rom|rom: ROM
237+
rpm: RPM
238+
s-record|S-Record|s-Record|SREC: S-record
239+
samba|SAMBA: Samba
240+
Satellite server: Satellite Server
241+
SE-Linux|S-E Linux|SE Linux|selinux: SELinux
242+
Shadow Man|ShadowMan: Shadowman
243+
Shadow passwords: shadow passwords
244+
Shadow utilities: shadow utilities
245+
Smallrye: SmallRye
246+
smart NIC|Smart-NIC: SmartNIC
247+
Smart State|smart state|Smart state|Smartstate|Analysis: SmartState analysis
248+
socks: SOCKS
249+
software collection|Software collection: Software Collection
250+
Source Navigator: Source-Navigator^TM^
251+
Spec: spec
252+
Spice|spice: SPICE
253+
Spring boot: Spring Boot
254+
SR IOV: SR-IOV
255+
Ssh|ssh: SSH
256+
SSL handshake: TLS handshake
257+
SSL(?!/TLS): SSL/TLS
258+
standard Manager|standard environment: standalone Manager
259+
Staroffice|Star Office: StarOffice
260+
StartTLS|startTLS: STARTTLS
261+
StartX: startx
262+
STI|source to image: Source-to-Image (S2I)
263+
SU: su
264+
Subscription manifest: Subscription Manifest
265+
Sys V|System V: SysV
266+
system D|system D|SystemD|system d: systemd
267+
Technology preview|technology preview: Technology Preview
268+
The Operator Lifecycle Manager: Operator Lifecycle Manager
269+
Tolapai|Intel Tolapai: Intel(R) EP80579 Integrated Processor
270+
ttl: TTL
271+
uid: UID
272+
ULTRASPARC|UltraSparc: UltraSPARC
273+
Unix|unix|UNIX-like: UNIX
274+
url: URL
275+
urn: URN
276+
VCPU|vcpu: vCPU
277+
VI: vi
278+
VIM|vim: Vim
279+
Virtual Desktop Server Management: VDSM
280+
virtual-console|Virtual Console: virtual console
281+
vlan|vLAN: VLAN
282+
VM portal|vm portal|Virtual Machine Portal|User Portal: VM Portal
283+
vnic|VNIC|Virtual Network Interface Card: vNIC
284+
vnuma|VNUMA: vNUMA node
285+
vpn: VPN
286+
VS Code|VSCode|VisualStudioCode|VisualStudio Code: Visual Studio Code
287+
VT-i|VT: Intel Virtualization Technology
288+
wan: WAN
289+
wca: WCA
290+
web-UI|webUI: web UI
291+
Webauthn|webAuthn|WebAuthN: WebAuthn
292+
websocket|Websocket: WebSocket
293+
Window-Maker|WindowMaker: Window Maker
294+
Xemacs: XEmacs
295+
xplat-cli|x-plat-cli|xplat cli|x-plat cli|X-PLAT CLI|X-PLAT-CLI|XPLAT-CLI|XPLAT CLI: Microsoft Azure Cross-Platform Command-Line Interface
296+
Xp|xp: XP
297+
Xterm: xterm

styles/RedHat/Conjunctions.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
extends: existence
3+
level: suggestion
4+
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/conjunctions/
5+
message: "Do not overuse beginning sentences with '%s'."
6+
scope: paragraph
7+
source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml
8+
action:
9+
name: remove
10+
tokens:
11+
- ^And
12+
- ^But
13+
- ^Or
14+
- ^So

0 commit comments

Comments
 (0)