Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Thorough review of user guide as a whole #417

Closed
Preeticp opened this issue Aug 29, 2018 · 7 comments
Closed

Thorough review of user guide as a whole #417

Preeticp opened this issue Aug 29, 2018 · 7 comments
Assignees
Labels
enhancement SEV3 Please prioritize in your backlog at your discretion. User Guide

Comments

@Preeticp
Copy link
Collaborator

The User guide has not undergone a holistic review so far.
We need to split the guide among us and do a thorough review of the same as we are doing for the getting started now.
There are 2 cases where I feel this is relevant:

  1. We will need to use parts of it for the smaller Use cases.
  2. We need to consider the possibility of using it for Context sensitive help, in case we need to deliver it.
@Preeticp Preeticp added enhancement User Guide SEV3 Please prioritize in your backlog at your discretion. labels Aug 29, 2018
@rkratky
Copy link
Collaborator

rkratky commented Aug 29, 2018

Unassigning myself and Preeti. @mishaone, could you please DPM this and file separate issues (assigned to indiv. writers) for the indiv. review tasks?

@mishaone
Copy link
Contributor

mishaone commented Sep 3, 2018

I'll do that and close this task (probably after the minimalism session so that we don't need to do this twice).

@mishaone
Copy link
Contributor

mishaone commented Sep 3, 2018

@Preeticp actually I'm already tracking the minimalism review and subsequent action items in JIRA and will create issues here after that, so this is not really necessary. I would suggest making separate issues for the two additional items lumped in here with the review (breaking into smaller use cases and context sensitive help). We can create the former later after review, the latter I have no idea about and would possibly be best in a separate issue assigned to you or Robert, whoever is most familiar with the context sensitive help requirements?

@mishaone mishaone closed this as completed Sep 3, 2018
@Preeticp
Copy link
Collaborator Author

Preeticp commented Sep 3, 2018

@mishaone the idea earlier was to reuse the modules in User guide for context sensitive help too. Since this is still in the back log, I would suggest that we create an issue for it when it comes up. Meanwhile, when we do the smaller use cases or modifications to the User guide, we can keep this use case in mind too. As of now, we could use your review-follow-up issues. Also we have an issue tracking the smaller use cases we need in addition to existing ones in place: #415

@Preeticp
Copy link
Collaborator Author

Reopening this issue. I think a top level review to identify content which can be reused from here for the smaller use cases issue is required.
I will also check with the team here if we can get it reviewed in one of the minimalism review meetings.

@Preeticp Preeticp reopened this Sep 14, 2018
@Preeticp Preeticp assigned Preeticp and unassigned mishaone Sep 14, 2018
@Preeticp
Copy link
Collaborator Author

Preeticp commented Oct 12, 2018

This Issue mainly needs reordering of modules as follows, based on priority of tasks in OSIO:

  1. Space
  2. Codebase
  3. Pipelines
  4. workspaces
  5. Analytics
  6. Areas and Collaborators
  7. WI and Iterations
  8. Resources
    Created separate issues Pare down and update Planner section in UG #436 to take care of Planner modifications and Update Collaborator and Area section in UG #434 to update collaborator and Areas section.
    Otherwise most modules are in good shape.

Change password module has changed, update instructions and remove screenshots which are repeated from the previous module.

@Preeticp
Copy link
Collaborator Author

Preeticp commented Oct 17, 2018

#438 takes care of the introductory paragraphs and reorg of modules in UG. Closing this as the Planner, Areas, and collaborator sections are being done through #436 and #434

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement SEV3 Please prioritize in your backlog at your discretion. User Guide
Projects
None yet
Development

No branches or pull requests

3 participants