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

ug: include personas #692

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

vanmaegima
Copy link
Member

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

This includes a doc view based on personas for easier customer interaction.

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@vanmaegima vanmaegima marked this pull request as ready for review February 27, 2024 18:50
@vanmaegima
Copy link
Member Author

@angolini I've tried to address your comments from the first PR.

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@kprosise
Copy link
Contributor

Note regarding build failure: Issue have been fixed (and was unrelated to the PR).

Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
@doanac
Copy link
Member

doanac commented Feb 28, 2024

Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some concepts are still not clear to me, but I don't have anything against this doc so let's LGTM


* Sync meetings

* Ticket escalation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I prefer "ticket creation" over escalation here

Copy link
Member Author

@vanmaegima vanmaegima Feb 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, everybody can create tickets, however we need a main point of contact on their end to escalate information.
(I know this is not clear and all bullets need rework, but for now I'm just moving internal docs as is to this page)

@kprosise
Copy link
Contributor

@vanmaegima It is fine by me to go ahead and merge this as soon as you are ready.

@vanmaegima
Copy link
Member Author

@kprosise we're holding on this one a bit more to get more internal inputs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants