Spaces are a great tool to evolve and refine knowledge or to accumulate information on a given topic. You may also work collaboratively with your team to create user information on one of your products.
...
| Example Box | ||
|---|---|---|
| ||
|
| Example Box | ||
|---|---|---|
| ||
|
The upper half of both space homepages contains information for the space creator on what to do next. The lower half has a structure that is expected to be helpful during the lifetime of the space. It is usually the reason for selecting this type of space.
...
Due to the fact that we work together on different topics, such spaces are created and removed quite often. These spaces have the same basic structure. There may be differences for different kinds of work - collect information about a topic, brainstorm on new products, run a spike on a technical problem, and maybe moreso on. Each has type of work may have its own space blueprint to get the team started quickly without much further ado.
...
Resources, the glossary, references to experts are provided at the same location. Once the space is created the team is ready to add information. The important part is that the team starts working on the topic right away. They have a basic structure - they are familiar with - to add information collaboratively.
Maven Documentation Space
Here is an another example that walks you through a space blueprint to create user documentation for Maven plugins.
...
First start the Maven Space Wizard and add the name and key to the space and the G:A:V coordinates to your released artifact (we assume that the add-on is already property properly installed, i.e. has information on how to access the Nexus repository).
...
Let's start with the homepage of the new space!:
The space provides links to generates pages that provide information inform users about goals and how to download the plugin.
Maven Goals Page
A space blueprint may create more than just on page. The goals page is generated from information found in the artifact's plugin descriptor.
...
This plugin references three mojos that present their supported parameters by navigating to the mojo page.
Download Page
A space blueprint may create more than just on page. The space blueprint for Maven plugins also creates a page with information on how to download the plugin.
The download information is generated from the artifact's POM file. If the author switches the version to the next release, the links will update automatically at request time.
...
You may also provide a link that activates, once a page is created. The Usage label is not a link, since there is no usage page in this space, yet.
Now create that Usage page:
This is the new page rendered in the browser:
A link to that page is rendered on the homepage (after reloading the page):
Conclusion
If you are creating spaces frequently it makes sense to invest on creating space blueprints that match exactly you needs. Teams may then create a space and start working on work on their task without manually adjusting the create space that cannot be used out-of-the-boximmediately. There is no need to manually adjust the created space and remove parts of the sample content.
In the previous article we have introduced a number of macros that support page blueprint designers. Now you we have seen shown the Display List Macro, Section Macro, Content Marker Macro, and Wiki Link Macro in action.
...
- Employ templates to support
- writers (concentrate on content not structure or layout)
- readers (familiarity with structure and layout for types of documents)
- Use Sections and other projectdoc macros to render only meaningful parts of your page
- Create spaces frequently
- Use blueprints that do not generate too much elements you have to remove after creation
- Use workspace workspaces to collaborate on a topic
- Use wizards to create project spaces based on project metadata (like POMs and or plugin descriptors)
| Piwik Set One Custom Variable | ||||
|---|---|---|---|---|
|
