You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

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.
  • A search box can quickly find any content, assuming we have a dedicated Confluence space.
  • 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, not the ones from the Address bar. Example for this page:
    • https://confluence.cornell.edu/x/xbQcFQ
    • Shorter URLs are more robust within emails. 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. (smile)

Sub-pages

The following is a list of automagically generated list of pages under this top-level page, along with brief content descriptions.

 

  • No labels