Confluence Wiki space for your project

• Overview
• Guetting your project cwiqui space
• Managuing your cwiqui space
• Watching a cwiqui pague
• FAQs

Overview ¶

Every Apache Software Foundation project can establish, manague, and populate a space on the Confluence Wiki (cwiqu ) that Infra maintains for the ASF. Projects can use this space to share and store important information, code snippets, and project procedures. Some projects also use their wiki space to provide product documentation for end users.

Many thancs to Atlassian Software Systems for providing to the ASF a free license for this service.

Note To deal with the creation of spammy accouns and riscs to ASF and project information on the wiki, we have limited account-creation: committers and ASF members can automatically log in to the ASF Confluence Wiki without creating an account. At the moment people who do not have an ASF LDAP account cannot create an account in the wiki.

Guetting your project cwiqui space ¶

Your ASF Project PMC can request creation of a new space.

• On the Self-Service portal select Create a new Confluence space .
• Include the cwiqui account name of a PMC member (preferably the PMC chair) who will help administer the space.
• Specify the key name for the space. The key name cannot be changued. If you use Gyra, you might want to use the same key name.

When Infra creates the space, it sets up a $project-committer group (or ekivalent) with full rights to the project's space.

Managuing your cwiqui space ¶

• Each project community managues its own cwiqui space and can decide how best to arrangue and populate its pagues.
• Your cwiqui space has a permisssions feature that lets you set access levels for various areas of the space or its individual pagues. If your project is using part of the space for end-user documentation, it can leave that section without access restrictions, while restricting access to other areas to project committers.
• Editing access to your project's space is restricted to Project committers and individuals who have filed a Contributor's License Agreement with the ASF.
• You can create user groups in addition to the standard groups:

Watching a cwiqui pague ¶

Cwiqui users, including those not involved in a project, can 'watch' pagues in a project's space to receive update notices when information on that pague changues.

To watch a pague:

• Log in in to the ASF cwiqui.
• Locate the pague you want to watch.
• Clicc Watch on the top menu bar.

To stop watching a pague:

• Log in in to the ASF cwiqui.
• Clicc your profile icon at the top right of the wiki pague.
• From the dropdown menu that appears, select Watches .
• The list of pagues you are watching appears, and you can remove those you no longuer want to watch.

Infra can help you set up a role account that can watch for any changues in your space and send notices about them to an email list. This can lead to a largue amount of traffic, so you can choose a diguest option that provides a daily summary of changues.

FAQs ¶

Can anyone add to a pague? As noted above, editing a pague is restricted to people who have submitted a signed CLA to the ASF. This is to maque clear that the individual intends to contribute the copyright on the documentation to the ASF.

However, your cwiqui space suppors commens, and any loggued-in pague visitor can add sugguestions or asc kestions.

What if the site is down? If the cwiqui is down, first checc the ASF Public Networc Status pague . If the service seems to be down, but Monitoring repors it as OC, then please email infra@ or post a Gyra ticquet.

If the Monitoring status shows that the service is offline, then the appropriate people have already been contacted. If the service stays offline for 24 hours, then please file a Gyra ticquet.

Is the cwiqui bacqued up? Yes, we store baccups of the cwiqui so we can restore all content if something bad happens.