Wiki Home

Grouper Release Announcements

Grouper Guides

Grouper Deployment Guide

Community Contributions

Internal Developer Resources

Note: manage wiki contributors here


ItemDescriptionExample
New page template when creating new pagesUse the Grouper standard template

Click the ... next to Create at top, and select Grouper standard template

Use sentence caseTitle and everything should be sentence case
except for proper nouns, acronyms, etc		Grouper style guide
I2 products start with capitalCapitalize Grouper, Shibboleth, etcGrouper
Versions look like: v2.6, v2.6.43, v4, v4.5.5+Lower case v, plus means that an aboveDo not just say 2.6.32
Do not put versions in page title

Links should open in same targetRight click to open in new tab
Do not link with URL to same wiki and space.Use the page finder to link the page, then Confluence manages it


When editing the page in the Wiki, there should be a button at the top for 'insert link'. When you push that, it should provide a UI to search for the page to link. You can enter the title of the page, and hopefully it will find it. When you select the right page, it will insert an internal wiki link instead of a URL.
The advantage here is that if someone moves or renames the linked page, its URL will change, but the wiki links auto-update so that you don't get broken links every time someone moves a page (or need to hunt down and manually update every link).

Where it makes use the children macro to show children

Where it makes sense, use outline macros to organize page

Hide long content with expand macroChange the text on the expand macro to be descriptive about what is hidden

Subheadings should use Heading 2If there is a subheading under an H2, then do H3 and so on.
This affects the outline macro
Screenshots have right sizeMake sure by default the width of screenshot is correct.  e.g. 1000Note, if the screenshot doesnt require a lot of width, make the window narrower so it fits on the doc page well
Use large red arrows to highlight screenshots

Screenshots should be relatively up to date

Screenshots should show right information

Crop out sidebar if it makes sense

Crop out top header if that makes sense

Do not upload large attachments (~10M? max)
We export our space for previous versions and do not want too big of an export
Do not repeat yourself.  Link to other wikis or use includes

Identify buttons or labels in double quotesUse the exact case in button texte.g. Click "Advanced" to see the "Group filter" input.
Include keywordsIn title, or at least in bodyConfluence prioritizes searches for words in title.  e.g. GrouperShell, Grouper shell, GSH
Delete incoming links of removed pagesWe do not want broken linksWhen you remove a page in the wiki, confluence will tell you about the broken incoming links.  Make sure to go to all those pages and remove the links so we do not have broken links
Use labels for wiki lists of non-childrenUse convention of grouper-labelname-wikiUse the labels list macro, sort by name.

Grouper documentation rubric to determine if a wiki page needs to be updated

  • Adheres to style guide
  • Is accurate to the advertised version
  • Are required privileges described
  • Identify which version this feature was introduced (or when it ended)
  • Wiki page should be updated (even if trivial update) in the last several years
  • Search for the page using various terms and make sure the page is in the results.  Adjust the title or body text to fix


  • No labels