Call Us Today! 877.742.2583




Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can help update the documentation of FreeSWITCH by joining the Docs Team, especially if you are an expert at a particular module or application of FreeSWITCH.

  • Create a JIRA account if you haven't already.This allows you to access Confluence and all the Atlassian applications associated with the
    Fs
    project.
  • Log in with your JIRA account.
  • Then, send a message to John Boteler or Italo Rossi requesting to be added to the confluence-editors group. (This helps limit defacement of pages.)

How To Get Started

Learn Basics of Confluence

Please watch this video, at least the first 30minutes, it will teach you the basics of Confluence (starting at minute 5:00 )

Widget Connector
urlhttps://www.youtube.com/watch?v=uhWCMlcY_Zw

Create Your Personal Space

Your personal personal Confluence space is a place where you can publish your own pages and play around in a sandbox to see what Confluence can do.

 https://confluence.atlassian.com/display/DOC/Setting+Up+your+Personal+Space

...

Old Wiki Retired

We are closing in on moving have moved the last pages from MediaWiki to Confluence. Watch for announcements of docs sprints.

It is essential to follow the workflow on the Wiki Migration page so that you don't perform duplicate work and waste your time.

Why We Are Migrating

  • To improve the FreeSWITCH documentation
  • Wiki (https://wiki.freeswitch.org/wiki) has become very unorganized
  • To start fresh with a new, well thought-out layout and ToC
  • To integrate with JIRA

 

Now comes the task of formatting each page to Confluence specifications and moving it to an appropriate location in the Table of Contents. Note that each page still stands independently regardless of its appearance in the Table of Contents pane, but widgets on the page such as "Child Pages" use their hierarchical relationship in the ToC to present the information properly.

Start Helping With Formatting Pages

First read carefully our Confluence guidelines : Confluence Wiki Standards and Guidelines

A lot Many of the pages that have been moved already but still need reformatting; this is an easy way to get started with the FreeSWITCH documentation project.

Once you are comfortable with basics of Confluence, it will be more easy to start your own page and help moving the old wiki pages to Confluence.

How to help with formatting and layout? Well, some pages may still need to have code samples placed into the "code macro" (https://confluence.atlassian.com/display/DOC/Code+Block+Macro), long pages may need a proper 'Table of Contents' macro inserted near the top, and basically anything that you can think of to make the page look better.

...

anthm wants the documentation to match the currently available software. The term "stable" is deprecated. A "stable" release only means that it is no longer being touched by developers, not that it is free of bugs, so there is nothing magical about that term. Keeping only one documentation knowledge base that matches current code base parallels the idea that JIRA tickets will only be considered if tested against the latest code base. This makes documentation easier because it evolves with the software and there's only one knowledge base to update.