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

Compare with Current View Page History

« Previous Version 7 Next »

The Apache Tuscany Project Website (http://incubator.apache.org/tuscany) content is authored collaboratively by the Tuscany community.  The content authoring and publish takes place in the following steps:-

There is more information at the end of this page on how content is synchronized from the Wiki to the public site.

Since the Wiki content forms the backbone for the public website content, it is important that the community adheres to some community accepted common guidelines when authoring content on the Wiki, to help in consistency and maintainability of the content.  The objective of this page is to record these guidelines.

Tuscany cwiki versus Tuscany website

The Apache Tuscany project uses cwiki.apache.org as it's wiki and primary place to maintain information about the project. This wiki is based on Confluence.

Apache Tuscany's wiki is organized in one Confluence space under 'Tuscany' to facilitate the administration.

We use an autoexport plugin that automatically converts Confluence's native, and dynamically generated content into a static HTML version that gets exported to the Tuscany website which is located at incubator.apache.org/Tuscany.

Wiki Layout - Important

Tuscany consists of many projects, including SCA, SDO and DAS. All subprojects are implemented in C++ and Java which would result in different documentation and download pages. There is a lot of information that gets shared on the website related to all these projects and it is essential to have a clear structure to help ease the administration, modification and maintenance of the website. Here is a proposal for how the information on cwiki can be organized with this goal in mind.

Need to make sure community is in agreement before we make this the guideline - so, here is the proposal.

Tuscany cwiki is divided into two logical spaces.

  1. Tuscany General space: this is where you will find general Tuscany information, for example community, blogs, documentation and downloands for Tuscany. These pages will general information: Home, SCA Overview, SDO Overview, DAS Overview. All these pages use the same navigation.
  1. Tuscany Subproject space: There is a 'logical' space for each subproject under Tuscany. For example, SCA Java, SDO Java, SCA Native, etc. When under a subproject, you'll only find information about the subproject. Each subproject uses its own menu (which is similar for all subprojects) to navigate through pages for that subproject. This means navigation remains constant when traversing through pages of a subproject.

Wiki tree structure

Tuscany

  • Home
    • SCA Overview (general)
      • SCA Java (subproject)
        (lightbulb) You will find a similar structure as SCA Java under all other subprojects (SCA Native, SDO Java, DAS Java, ...)
        • SCA Java Subproject Documentation Menu - All publishable documentations are under this
        • SCA Java Releases - All release download pages for the subproject are under this
        • SCA Java Work-in-progress - This is place holder for work in progress. For example, discussion about new release, documentation in progress, etc. would all go under this category
      • SCA Native (subproject)
    • SDO Overview (general)
      • SDO Java (subproject)
      • SDO Native (subproject)
    • DAS Overview (general)
      • DAS Java (subproject)
      • DAS Native (subproject)
    • General Info (general) - holds information applicable to all projects. For example, Events, documentat/download, community, etc.
    • Menus - You will find all menus under here
      • General - You will find general menu here
      • Subproject Menus - You will find subproject specific menus here

Naming convention

How to deploy to convert Cofluence Native to Apache Tuscany website

Resources

  • No labels