Skip to content

Commit 73c2c9c

Browse files
authored
Peer review feedback (#880)
1 parent 3c16a36 commit 73c2c9c

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

modules/creating-project-scoped-resources-for-your-project.adoc

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
= Creating project-scoped resources for your project
55

66
[role='_abstract']
7-
Users can access _global resources_ in all {productname-short} projects, but can access _project-scoped resources_ within the specified project only.
7+
As an {productname-short} user, you can access _global resources_ in all {productname-short} projects, but you can access _project-scoped resources_ within the specified project only.
88

9-
A project member who is not a cluster administrator can create the following types of project-scoped resources for their {productname-short} project:
9+
As a user with access permissions to a project, you can create the following types of project-scoped resources for your {productname-short} project:
1010

1111
* Workbench images
1212
* Model-serving runtimes for KServe
@@ -21,10 +21,10 @@ All resource names must be unique within a project.
2121
[NOTE]
2222
====
2323
ifdef::upstream[]
24-
Cluster administrators can create project-scoped resources for any project, as described in link:{odhdocshome}/managing-odh/#creating-project-scoped-resources_managing-odh[Creating project-scoped resources].
24+
A user with access permissions to a project can create project-scoped resources for that project, as described in link:{odhdocshome}/managing-odh/#creating-project-scoped-resources_managing-odh[Creating project-scoped resources].
2525
endif::[]
2626
ifndef::upstream[]
27-
Cluster administrators can create project-scoped resources for any project, as described in link:{rhoaidocshome}{default-format-url}/managing_openshift_ai/creating-project-scoped-resources_managing-rhoai[Creating project-scoped resources].
27+
A user with access permissions to a project can create project-scoped resources for that project, as described in link:{rhoaidocshome}{default-format-url}/managing_openshift_ai/creating-project-scoped-resources_managing-rhoai[Creating project-scoped resources].
2828
endif::[]
2929
====
3030

@@ -48,13 +48,14 @@ Alternatively, you can contact your cluster administrator to request the relevan
4848

4949

5050
.Procedure
51+
5152
. Log in to the {openshift-platform} console.
52-
. Copy the YAML code from a trusted source to create the resource.
53+
. From a trusted source, copy the YAML code that you want to use for your project resource.
5354
+
54-
Alternatively, if you can access an existing project-scoped resource in one of your projects, you can copy the YAML code as follows:
55+
For example, if you can access an existing project-scoped resource in one of your projects, you can copy the YAML code as follows:
5556

5657
.. In the *Administrator* perspective, click *Home* -> *Search*.
57-
.. From the *Projects* list, select the appropriate value.
58+
.. From the *Projects* list, select the appropriate project.
5859
.. In the *Resources* list, search for the relevant resource type, as follows:
5960

6061
* For workbench images, search for `ImageStream`.
@@ -64,10 +65,10 @@ Alternatively, if you can access an existing project-scoped resource in one of y
6465
* For serving runtimes, search for `Template`.
6566
From the resulting list, find the templates that have the `objects.kind` specification set to `ServingRuntime`.
6667

67-
.. Select a resource, and click the *YAML* tab.
68-
.. Copy the YAML content, and click *Cancel*.
68+
.. Select a resource, and then click the *YAML* tab.
69+
.. Copy the YAML content, and then click *Cancel*.
6970

70-
. From the *Project* list, select your project name. Note the spelling.
71+
. From the *Project* list, select your project name.
7172
. From the toolbar, click the *+* icon to open the *Import YAML* page.
7273
. Paste the example YAML content into the code area.
7374
. Edit the `metadata.namespace` value to specify the name of your project.
@@ -82,31 +83,32 @@ From the resulting list, find the templates that have the `objects.kind` specifi
8283

8384

8485
.Verification
86+
8587
. Log in to the {productname-short} console.
86-
. Verify that the project-scoped resource is shown in the specified project only:
88+
. Verify that the project-scoped resource is shown in the specified project:
8789

8890
ifdef::upstream[]
89-
* For workbench images, see link:{odhdocshome}/working-on-data-science-projects/#creating-a-project-workbench_projects[Creating a workbench].
91+
* For workbench images, when you create a workbench in the project, as described in link:{odhdocshome}/working-on-data-science-projects/#creating-a-project-workbench_projects[Creating a workbench], the workbench image that you added is available in the *Image selection* list.
9092
endif::[]
9193
ifndef::upstream[]
92-
* For workbench images, see link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/using-project-workbenches_projects#creating-a-project-workbench_projects[Creating a workbench].
94+
* For workbench images, when you create a workbench in the project, as described in link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/using-project-workbenches_projects#creating-a-project-workbench_projects[Creating a workbench], the workbench image that you added is available in the *Image selection* list.
9395
endif::[]
9496

9597
ifdef::upstream[]
96-
* For serving runtimes, see link:{odhdocshome}/serving-models/#deploying-models-on-the-single-model-serving-platform_serving-large-models[Deploying models on the single-model serving platform].
98+
* For model-serving runtimes, see link:{odhdocshome}/serving-models/#deploying-models-on-the-single-model-serving-platform_serving-large-models[Deploying models on the single-model serving platform].
9799
endif::[]
98100
ifndef::upstream[]
99-
* For serving runtimes, see link:{rhoaidocshome}{default-format-url}/serving_models/serving-large-models_serving-large-models#deploying-models-on-the-single-model-serving-platform_serving-large-models[Deploying models on the single-model serving platform].
101+
* For model-serving runtimes, see link:{rhoaidocshome}{default-format-url}/serving_models/serving-large-models_serving-large-models#deploying-models-on-the-single-model-serving-platform_serving-large-models[Deploying models on the single-model serving platform].
100102
endif::[]
101103

102104
////
103105
When RHOAIENG-26758 is resolved, remove the above lines and uncomment this section instead.
104106
105107
ifdef::upstream[]
106-
* For workbench images, hardware profiles, and accelerator profiles, see link:{odhdocshome}/working-on-data-science-projects/#creating-a-project-workbench_projects[Creating a workbench].
108+
* For workbench images, hardware profiles, and accelerator profiles, when you create a workbench in the project, as described in link:{odhdocshome}/working-on-data-science-projects/#creating-a-project-workbench_projects[Creating a workbench], the workbench image that you added is available in the *Image selection* list.
107109
endif::[]
108110
ifndef::upstream[]
109-
* For workbench images, hardware profiles, and accelerator profiles, see link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/using-project-workbenches_projects#creating-a-project-workbench_projects[Creating a workbench].
111+
* For workbench images, hardware profiles, and accelerator profiles, when you create a workbench in the project, as described in link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/using-project-workbenches_projects#creating-a-project-workbench_projects[Creating a workbench], the workbench image that you added is available in the *Image selection* list.
110112
endif::[]
111113
112114
ifdef::upstream[]

modules/creating-project-scoped-resources.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
= Creating project-scoped resources
55

66
[role='_abstract']
7-
Users can access _global resources_ in all {productname-short} projects, but can access _project-scoped resources_ within the specified project only.
7+
{productname-short} users can access _global resources_ in all {productname-short} projects. However, they can access _project-scoped resources_ only within projects that they have permissions to access.
88

9-
Cluster administrators can create the following types of project-scoped resources in any {productname-short} project:
9+
As a cluster administrator, you can create the following types of project-scoped resources in any {productname-short} project:
1010

1111
* Workbench images
1212
* Hardware profiles
@@ -19,10 +19,10 @@ All resource names must be unique within a project.
1919
[NOTE]
2020
====
2121
ifdef::upstream[]
22-
A project member who is not a cluster administrator can create project-scoped resources for their project, as described in link:{odhdocshome}/working-on-data-science-projects/#creating-project-scoped-resources-for-your-project_projects[Creating project-scoped resources for your project].
22+
A user with access permissions to a project can create project-scoped resources for that project, as described in link:{odhdocshome}/working-on-data-science-projects/#creating-project-scoped-resources-for-your-project_projects[Creating project-scoped resources for your project].
2323
endif::[]
2424
ifndef::upstream[]
25-
A project member who is not a cluster administrator can create project-scoped resources for their project, as described in link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/creating-project-scoped-resources-for-your-project_projects[Creating project-scoped resources for your project].
25+
A user with access permissions to a project can create project-scoped resources for that project, as described in link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/creating-project-scoped-resources-for-your-project_projects[Creating project-scoped resources for your project].
2626
endif::[]
2727
====
2828

@@ -39,6 +39,7 @@ endif::[]
3939

4040

4141
.Procedure
42+
4243
. Log in to the {openshift-platform} console as a cluster administrator.
4344
. Copy the YAML code to create the resource.
4445
+
@@ -47,31 +48,31 @@ You can get the YAML code from a trusted source, such as an existing resource, a
4748
For example, you can copy the YAML code from an existing resource, as follows:
4849

4950
.. In the *Administrator* perspective, click *Home* -> *Search*.
50-
.. From the *Project* list, select the appropriate value.
51+
.. From the *Project* list, select the appropriate project.
5152
+
5253
ifdef::upstream[]
5354
To limit the search to global {productname-short} resources only, select the `opendatahub` project.
5455
endif::[]
5556
ifndef::upstream[]
5657
To limit the search to global {productname-short} resources only, select the `redhat-ods-applications` project.
5758
endif::[]
58-
.. In the *Resources* list, search for the relevant resource type, as follows:
59+
.. In the *Resources* list, search for the relevant resource type:
5960

6061
* For workbench images, search for `ImageStream`.
6162
* For hardware profiles, search for `HardwareProfile`.
6263
* For accelerator profiles, search for `AcceleratorProfile`.
6364
* For serving runtimes, search for `Template`.
6465
From the resulting list, find the templates that have the `objects.kind` specification set to `ServingRuntime`.
6566

66-
.. Select a resource, and click the *YAML* tab.
67-
.. Copy the YAML content, and click *Cancel*.
67+
.. Select a resource, and then click the *YAML* tab.
68+
.. Copy the YAML content, and then click *Cancel*.
6869

69-
. From the *Project* list, select the target project name. Note the spelling.
70+
. From the *Project* list, select the target project name.
7071
. From the toolbar, click the *+* icon to open the *Import YAML* page.
7172
. Paste the relevant YAML content into the code area.
7273
. Edit the `metadata.namespace` value to specify the name of the target project.
7374
. If necessary, edit the `metadata.name` value to ensure that the resource name is unique within the specified project.
74-
. Optional: Edit the resource name that is displayed in the {productname-short} console, as follows:
75+
. Optional: Edit the resource name that is displayed in the {productname-short} console:
7576

7677
* For workbench images, edit the `metadata.annotations.opendatahub.io/notebook-image-name` value.
7778
* For hardware profiles and accelerator profiles, edit the `spec.displayName` value.
@@ -82,7 +83,7 @@ From the resulting list, find the templates that have the `objects.kind` specifi
8283

8384
.Verification
8485
. Log in to the {productname-short} console as a regular user.
85-
. Verify that the project-scoped resource is shown in the specified project only:
86+
. Verify that the project-scoped resource is shown in the specified project:
8687

8788
ifdef::upstream[]
8889
* For workbench images, hardware profiles, and accelerator profiles, see link:{odhdocshome}/working-on-data-science-projects/#creating-a-project-workbench_projects[Creating a workbench].

0 commit comments

Comments
 (0)