RHDEVDOCS-3866 Merging the accessing perspectives sections #52924

shreyasiddhartha · 2022-11-17T12:28:02Z

RHDEVDOCS-3866: Doc updates-Update Developer Perspective content based on recognized user/Merging the accessing perspectives sections
OpenShift 4.11 Freeze
JIRA issues: RHDEVDOCS-3866

SME Review: @jerolimov
QE Review: @sanketpathak

ocpdocs-previewbot · 2022-11-17T13:04:19Z

🤖 Updated build preview is available at:
https://52924--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/4362

invincibleJai · 2022-11-17T14:08:42Z

modules/about-developer-perspective.adoc

@@ -27,3 +27,8 @@ The *Developer* perspective provides workflows specific to developer use cases,
 * Group components within an application and connect the components within and across applications.
 * Integrate serverless capabilities (Technology Preview).
 * Create workspaces to edit your application code using Eclipse Che.
+
+You can use the *Topology* view to display the list of all the projects in your cluster. If you have no workloads or applications in the project, the *Topology* view displays the available options to create applications. If you have existing workloads, the *Topology* view graphically displays your workload nodes.


You can use the *Topology* view to display the list of all the projects in your cluster

this doesn't seem very right, topology view is meant to list all the applications/workloads

@invincibleJai, this section's content is not created but only moved from Accessing the Developer Perspective to About Developer Perspective. Are you sure if you want to change this? If yes, I can rephrase the first line.

@shreyasiddhartha can you point me to that?

as in this PR i see the reference of topology here which has been removed and here it makes sense as context is changed https://github.com/openshift/openshift-docs/pull/52924/files#diff-c2da23386f560a8b8887b75439ea41c909b6963a8115932738a09ec1c48794ecL18-L25

Agree with Jai, also if its moved we should improve this anyway. The topology view is about showing workloads.

You want to change the first sentence to

Suggested change

You can use the *Topology* view to display the list of all the projects in your cluster. If you have no workloads or applications in the project, the *Topology* view displays the available options to create applications. If you have existing workloads, the *Topology* view graphically displays your workload nodes.

You can use the *Topology* view to display applications, components and workloads of your project. If you have no workloads in the project, the *Topology* view will show some links to create or import them. You can also use the *Quick Search* to import components directly.

yeah above suggestion looks good technically and depending on the context can add if no namespace/project is selected and the user goes to the developer perspective then the topology view shows the list of namespaces/projects if any exist.

Thanks @jerolimov. The above suggestion looks good to me as well. I'm adding an additional serial comma before "and" in the suggested changes.

invincibleJai · 2022-11-17T14:10:36Z

modules/odc-accessing-perspectives.adoc

+You can access the *Administrator* and *Developer* perspective from the web console as follows:
+
+.Prerequisites
+To access a perspective, ensure that you have logged in to the web console. Your default perspective is determined by your role.


not sure if we need to get into details of what these role is

@jerolimov WDYT?

Yeah this might be interesting to some users, we've got this question also in the past from associates who uses the web console UI less often.

Maybe like this:

Suggested change

To access a perspective, ensure that you have logged in to the web console. Your default perspective is determined by your role.

To access a perspective, ensure that you have logged in to the web console. Your default perspective is automatically determined by the permission of the users. The *Administrator* perspective is selected for users with access to all projects, while the *Developer* perspective is selected for users with limited access to just their own projects.

Wdyt @invincibleJai and @shreyasiddhartha ?

Thanks @jerolimov , this looks better IMO

Thank you @jerolimov. Additionally I'm removing "just" from from the suggested changes.

invincibleJai · 2022-11-24T13:09:31Z

/cc @jerolimov

jerolimov · 2022-11-24T16:02:27Z

modules/odc-accessing-perspectives.adoc

+
+. Use the perspective switcher to switch to the *Administrator* or *Developer* perspective.
+
+. Select an existing project from the list or use the *Project* drop-down list to create a new project.


I don't understand what "from the list" means here. Esp. new users without access to any project (that is a common case!) will not have such a list. I want to suggest to focus here on the project dropdown:

Suggested change

. Select an existing project from the list or use the *Project* drop-down list to create a new project.

. Select an existing project from the *Project* drop-down list. You can also create a new project from this dropdown.

jerolimov · 2022-11-24T16:08:42Z

Added some comments/recommendations to align the doc a little bit more for users that will use the Developer perspective the first time. This first usage experience might have changed in the Developer perspective over the last releases, step by step.

Sanket will be the right person to give lgtm from the QE perspective.

/cc @sanketpathak @serenamarie125

sanketpathak · 2022-12-13T17:30:20Z

LGTM

openshift-bot · 2023-03-14T01:00:42Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-merge-robot · 2023-03-14T01:00:52Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-bot · 2023-04-13T08:30:40Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2023-05-14T00:00:19Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2023-05-14T00:00:41Z

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 17, 2022

shreyasiddhartha force-pushed the RHDEVDOCS-3866 branch from a236685 to 17fa090 Compare November 17, 2022 12:55

invincibleJai reviewed Nov 17, 2022

View reviewed changes

shreyasiddhartha requested a review from invincibleJai November 24, 2022 10:47

openshift-ci bot requested a review from jerolimov November 24, 2022 13:09

jerolimov reviewed Nov 24, 2022

View reviewed changes

openshift-ci bot requested review from sanketpathak and serenamarie125 November 24, 2022 16:08

RHDEVDOCS-3866 Merging the accessing perspectives sections

53d616e

shreyasiddhartha force-pushed the RHDEVDOCS-3866 branch from 17fa090 to 53d616e Compare December 1, 2022 08:18

shreyasiddhartha mentioned this pull request Jan 4, 2023

Sample rhdevdocs 3866 #54197

Merged

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 14, 2023

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 14, 2023

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 13, 2023

openshift-ci bot closed this May 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RHDEVDOCS-3866 Merging the accessing perspectives sections #52924

RHDEVDOCS-3866 Merging the accessing perspectives sections #52924

shreyasiddhartha commented Nov 17, 2022 •

edited

ocpdocs-previewbot commented Nov 17, 2022 •

edited

invincibleJai Nov 17, 2022

shreyasiddhartha Nov 24, 2022

invincibleJai Nov 24, 2022 •

edited

jerolimov Nov 24, 2022

invincibleJai Nov 28, 2022

shreyasiddhartha Dec 1, 2022

invincibleJai Nov 17, 2022

jerolimov Nov 24, 2022 •

edited

invincibleJai Nov 28, 2022

shreyasiddhartha Dec 1, 2022

invincibleJai commented Nov 24, 2022

jerolimov Nov 24, 2022 •

edited

jerolimov commented Nov 24, 2022 •

edited

sanketpathak commented Dec 13, 2022

openshift-bot commented Mar 14, 2023

openshift-merge-robot commented Mar 14, 2023

openshift-bot commented Apr 13, 2023

openshift-bot commented May 14, 2023

openshift-ci bot commented May 14, 2023

	You can use the Topology view to display the list of all the projects in your cluster. If you have no workloads or applications in the project, the Topology view displays the available options to create applications. If you have existing workloads, the Topology view graphically displays your workload nodes.
	You can use the Topology view to display applications, components and workloads of your project. If you have no workloads in the project, the Topology view will show some links to create or import them. You can also use the Quick Search to import components directly.

	To access a perspective, ensure that you have logged in to the web console. Your default perspective is determined by your role.
	To access a perspective, ensure that you have logged in to the web console. Your default perspective is automatically determined by the permission of the users. The Administrator perspective is selected for users with access to all projects, while the Developer perspective is selected for users with limited access to just their own projects.


		. Use the perspective switcher to switch to the Administrator or Developer perspective.

		. Select an existing project from the list or use the Project drop-down list to create a new project.

	. Select an existing project from the list or use the Project drop-down list to create a new project.
	. Select an existing project from the Project drop-down list. You can also create a new project from this dropdown.

RHDEVDOCS-3866 Merging the accessing perspectives sections #52924

RHDEVDOCS-3866 Merging the accessing perspectives sections #52924

Conversation

shreyasiddhartha commented Nov 17, 2022 • edited

ocpdocs-previewbot commented Nov 17, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

invincibleJai Nov 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerolimov Nov 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

invincibleJai commented Nov 24, 2022

jerolimov Nov 24, 2022 • edited

Choose a reason for hiding this comment

jerolimov commented Nov 24, 2022 • edited

sanketpathak commented Dec 13, 2022

openshift-bot commented Mar 14, 2023

openshift-merge-robot commented Mar 14, 2023

openshift-bot commented Apr 13, 2023

openshift-bot commented May 14, 2023

openshift-ci bot commented May 14, 2023

shreyasiddhartha commented Nov 17, 2022 •

edited

ocpdocs-previewbot commented Nov 17, 2022 •

edited

invincibleJai Nov 24, 2022 •

edited

jerolimov Nov 24, 2022 •

edited

jerolimov Nov 24, 2022 •

edited

jerolimov commented Nov 24, 2022 •

edited