Skip to content

Commit

Permalink
style(agile handbook): Add buttons to navigate back and forth thru ha…
Browse files Browse the repository at this point in the history
…ndbook
  • Loading branch information
austin-schaefer committed Oct 8, 2021
1 parent 045c175 commit 563371f
Show file tree
Hide file tree
Showing 12 changed files with 192 additions and 10 deletions.
10 changes: 10 additions & 0 deletions src/content/docs/agile-handbook/appendices/backlog-review.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ When you review an issue, perform the following checks:
- This helps keep track of which issues you've reviewed on this round of backlog review
- It's also a useful nudge for future round of review: If an issue has more than one or two review labels, you should probably close it.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/appendices/project-scoping-cheatsheet/"
variant="secondary"
>
← Appendix: Project scoping cheatsheet
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,24 @@ We use this cheatsheet to help us scope projects in a consistent way.
+ Do we need JIRAs?
+ Who is following up with who?

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/appendices/ticket-best-practices/"
variant="secondary"
>
← Appendix: Ticket best practices
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/appendices/backlog-review/"
variant="secondary"
>
Appendix: Backlog review →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,24 @@ When you edit the site, include the Jira issue key (DOC-1234, for example) in yo
</tbody>
</table>

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/heroing/managing-the-github-boards/"
variant="secondary"
>
← Managing the GitHub boards
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/appendices/project-scoping-cheatsheet/"
variant="secondary"
>
Appendix: Project scoping cheatsheet →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,24 @@ Blocked until something else happens. Usually this means it's waiting on answers

When a docs writer creates a pull request, it's their responsibility to merge it into `develop` at the appropriate time. After a reviewer is done with their pull reuqest review or peer edit, they move it into this column so the original writer can merge when ready.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/heroing/what-is-a-hero/"
variant="secondary"
>
← What is a hero?
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/appendices/ticket-best-practices/"
variant="secondary"
>
Appendix: Ticket best practices →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
18 changes: 18 additions & 0 deletions src/content/docs/agile-handbook/heroing/what-is-a-hero.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,24 @@ Common questions and requests include:

Our tech writers in Barcelona cover the 2nd shift heroing during their regular working hours. Unlike the US-based heroes, our Barcelona writers hero for an entire two-week sprint. Second-shift heroes cover both GitHub and Slack, but we don't expect that second-shift heroes will field every single request that comes in during their working hours since they're also carrying standard sprint duties during their hero shift.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/liaisonships/"
variant="secondary"
>
← Liaisonships
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/heroing/managing-the-github-boards/"
variant="secondary"
>
Managing the GitHub boards →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
18 changes: 18 additions & 0 deletions src/content/docs/agile-handbook/key-concepts/agile-roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,24 @@ Key stakeholders include executives, PMs, engineers, and designers. Writers work

We should ensure our stakeholders know that we work in two week sprints, so that they can give us adequate lead time and get their documentation needs met.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/key-concepts/key-agile-principles/"
variant="secondary"
>
← Key agile principles
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/meetings-and-ceremonies/"
variant="secondary"
>
Meetings and ceremonies →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,7 @@ Each squad is responsible for its own grooming and sprint planning, but the mana
<ButtonGroup>
<ButtonLink
role="button"
to="3379_INSERT_LINK_HERE"
variant="secondary"
>
← Introduction
</ButtonLink>

<ButtonLink
role="button"
to="3379_INSERT_LINK_HERE"
to="/docs/agile-handbook/key-concepts/key-agile-principles/"
variant="secondary"
>
Key agile principles →
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ In order to reward teams that help us work this way, we prioritize this work in

This lets us create win-wins: Rather than a simple "no," a requestor can decide whether they truly need that content out _now_ (in which case they can create that first draft) or whether they're okay waiting a week or two.

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/agile-handbook/key-concepts/agile-sprints-profusion-of-terms/"
variant="secondary"
>
← Agile vs sprints: A profusion of terms
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/key-concepts/agile-roles/"
variant="secondary"
>
Agile roles →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
18 changes: 18 additions & 0 deletions src/content/docs/agile-handbook/sprint-mechanics/liaisonships.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,24 @@ However, a liaison is not the only author on a project. Liaisons should structur
</tbody>
</table>

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/sprint-workflow-and-jira-boards/"
variant="secondary"
>
← Sprint workflow and Jira boards
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/heroing/what-is-a-hero/"
variant="secondary"
>
What is a hero? →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,24 @@ At the end of the sprint, we conduct a 60 minute Retrospective meeting, where we

The goal of the Retro is to improve the way we work together. That could be related to the sprint process, to how we collaborate with SMEs, to peer edits, and so on.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/key-concepts/agile-roles/"
variant="secondary"
>
← Agile roles
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/planning-poker/"
variant="secondary"
>
Planning poker →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,24 @@ Once you know your baseline, calculating the budget is straightforward:

Because we work in two [squads](3379_INSERT_LINK_HERE), we calculate a separate points budget for each squad ahead of sprint planning.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/meetings-and-ceremonies/"
variant="secondary"
>
← Meetings and ceremonies
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/sprint-workflow-and-jira-boards/"
variant="secondary"
>
Sprint workflow and Jira boards →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,24 @@ For each open story assigned to you (or "carry over"), decide if you should:
1. Update the action items and description to make sure they're still current.
2. Note why we moved to the backlog rather than carry over.

<ButtonGroup>
<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/planning-poker/"
variant="secondary"
>
← Planning poker
</ButtonLink>

<ButtonLink
role="button"
to="https://docswebsitedevelop-pmhandbook.gtsb.io/docs/agile-handbook/sprint-mechanics/liaisonships/"
variant="secondary"
>
Liaisonships →
</ButtonLink>
</ButtonGroup>

## For more help

We welcome thoughts or questions on our handbook! The easiest way to get in touch is to [file a GitHub issue](https://github.com/newrelic/docs-website/issues/new/choose).

0 comments on commit 563371f

Please sign in to comment.