Using a wiki can prove a bit difficult when you're not used to it. Learn how to best handle the wiki: understanding its structure, getting the most useful infos at hand, using the macros to easily add content with respect to the contributions rules.
Numerous ways to find the information you want are available.
You can discover all of them on your own, or take a quick glance on this browsing helper.
Using the header
- As on most websites, the Petals Documentation logo brings back to the homepage.
- The top-right bar is shared between all Petals community websites.
Use it for a quick jump between corporate website (infos on commercial support), community website (technical infos), forum (community support), downloads (to get Petals products), and documentation (this wiki).
Using the top navigation bar
This is the main navigation bar:
On the left part is the breadcrumb, to quickly access parent pages of the one currently viewed.
On the right part, from left to right:
- the browse menu: allows to browse a whole space's content by type: pages (wiki content), labels (browse content by keyword), attachments (all images, docs and others in this space), advanced (to export part or all of space in html/pdf), space admin (administration panel for space administrators).
- the user menu: if authenticated, this menu will be named after your full name, and give access to [useful features]. Otherwise, links to login or signup will be displayed.
- search panel: use this panel to look for content throughout whole website. Results will be displayed on-the-fly. Clicking on the last option (Search for xxx) will bring you to a detailed search panel.
Using the navigation sidebar
On every page, a left-sidebar is available, and contains a hierarchical view of the current space. To hide it and view current content with full screen width, click on this icon in the navigation bar. To display again, click on the same place.
Why register?
Registering to our documentation website is free, quick, and brings you these nices features:
- define your favourite spaces (website sections) and pages, you'll see them directly on home page once authenticated.
- watch pages and people, and receives automatic email notifications when related content is updated!
- comment pages and contribute to content (with regards to Contributors Guideline)
- get a personal space (on request) fully writable and customizable, and set it as your landing point.
Wait no more, register now!
Using favourites pages and spaces
What is a favourite? It's either a page or space that you check with clicking on the star icon next to it. You can then view all of them in a centralized view.
Setting a page or space as favourite
For a Space
When you're on the default welcome page of the website, you'll see a list of spaces, each one having at the right end, a gray star icon. Click on this star to mark the space as favourite. Favourite spaces are identified by a yellow star.
For a Page
When viewing a page, use the right "Tools" menu, then select "Favourite". You can also check herein if a page is marked as a favourite or not.
Viewing favourites
For Spaces
On the standard homepage, once authenticated, you'll see a tabbed list of spaces. Click on "My" tab to see only the spaces you marked as favourite.
for Pages
You can see them on the standard landing page. You can also add them yo the Home of your Personal Space thanks to the {favpages} macros.
Watching pages and people
Time for lazyness! Atlassian people made a great job in writing their documentation, why would we reinvent the wheel?
Watching a Space
Watching a Page
Managing Spaces
To configure your email settings, go to the settings > email menu of your user profile and tick desired option(s).
Updating your user profile
All your
profile informations and settings
can be accessed from any pages, by clicking on your name on the right of top menubar.
A dropdown menu is also available when hovering the pointer on your name, providing quick access to:
- update status: quick note on what you're doing, thinking... Expressing the thoughts of one moment and tell other people what you're working on.
- recently viewed: the latest pages you viewed/modified.
- profile: your personal informations.
- network: the people you follow, and the ones following you.
- status update: history of your status.
- labels: see the content you marked with a "my:xxx" label.
- watches: list of pages you're watching.
- drafts: saves of content you have been editing without saving modifications.
- settings: you can configure here your landing page (when you connect), your timezone and preferred language.
Rules of contribution
Please take special note that any contribution to the wiki is ruled by our Contributors Guideline. Please read them carefully (in short, you accept that all of your contributions on this documentation wiki are published under CC-by-nc-sa, and you authorize Petals Link (EBM Websourcing) to use any and all of it in commercial offers, without any royalties or compensation. |
Creating pages
How to create pages
Atlassian documentation is very well made: Atlassian Confluence User Guide
Best practices
Editing pages
How to edit pages
See the Atlassian User Guide