A page to demonstration what JOC's documentation might look like if within CU Confluence using specific conventions particular to Confluence.
See also
- Add a link to A&S JAMF Pro change log, if not here.
- Perhaps in A&S IT's SharePoint instance?
Conventions used here or proposed
- Every page has a brief page description.
- This is because all page titles and descriptions available to be made visible to any page above.
- Pages are created (and possibly moved around) to ensure a rationale hierarchy.
- Pages higher in the hierarchy dedicate more space to describing sub-pages via "Children Display" code (think "branches"). And pages lower in the hierarchy have more detailed info (think "leaves").
- If a page starts having lots of info, consider breaking it up into sub-pages if logically related.
- The resulting higher-level page can summarize and guide finding the desired information.
- If a page starts having lots of info, consider breaking it up into sub-pages if logically related.
- A search box can quickly find any content, assuming we have a dedicated Confluence space.
- See top-level page to see this in action at Chemistry/ Physics.
- URLs of pages within the site, cited by other pages within Confluence, should use Confluence's linking and not explicitly citing it's URL.
- URLS shared outside of Confluence (say, via email) should ALWAYS be the smaller ones (", and NOT the ones from the Address bar. Example for this page:
- https://confluence.cornell.edu/x/xbQcFQ
- Shorter URLs are more robust within emails. And, importantly, these URLs persist if page is renamed or moved.
- Pressing the "k" key instantly provides you the short URL, pre-highlighted so easy to copy. That's one way to get that URL, and there is a reminder of this option every time it's used.
Sub-pages
The following is a list of auto-magically generated list of pages under this top-level page, along with brief content descriptions.
Example of using a TOC for data within a fuller page
Sometimes a lot needs to be put in one page rather than split up into sub-pages. A Table of Contents (TOC) auto-magically generated on that page can help orient a reader.
JOC Teams (Groups?) purpose, membership and contacts
The three current Teams are Production, Quality Control (QC), and Documentation.
- Documentation Team — Members: Member 1, Member 2, Member 3. Purpose: Get text from Fred or meeting's notes. Summarize for here, and fuller info can be on page itself.
- Production Team — Members: Member 1, Member 2, Member 3. Purpose: Get text from Fred or meeting's notes. Summarize for here, and fuller info can be on page itself.
- Quality Control Team — Members: Member 1, Member 2, Member 3. Purpose: Get text from Fred or meeting's notes. Summarize for here, and fuller info can be on page itself.