Apache Allura™ / Tickets / #1558 Update sphinx docs in Allura/docs/

#1558 Update sphinx docs in Allura/docs/

Milestone: v1.0.0

Status: closed

Owner: Jenny Steele

Labels: pycon (30) sf-4 (350)

Component: General

Reviewer: nobody

Updated: 2015-08-20

Created: 2011-02-23

Creator: Dave Brondsema

Private: No

Read the docs, try following them. Update/enhance as needed. Generated copy at http://allura.sourceforge.net/

Discussion

Dave Brondsema - 2011-02-23

summary: Update Allura/docs --> Update sphinx docs in Allura/docs/
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Dave Brondsema - 2011-02-24

size: --> 4
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Dave Brondsema - 2011-03-09

labels: --> pycon

milestone: mar-24 --> mar-17
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Notes from me & Jenny about what should be updated:

:::text
grep for pyforge and "new forge", change to Allura

http://allura.sourceforge.net/platform_tour.html
    move search from a tool to platform service
    remove home tool
    s/forum/discussion
    Ming Databases and the Context Object¶
        drop project database txt
        most of the time the "context" stuff is automagically set by the request
    [Ticket:#151] can just be [#151], and it's not "TIcket" but name of tool
    [Commit#abac332a] wrong, should be [code:asdfasdf] or just [asdfasdf]
    "Asynchronous Processing¶"
        most of this will change soon
    "Migrations"
        delete
http://allura.sourceforge.net/tutorials/wiki-tool.html
    need to write it
    delete the paster template too
http://allura.sourceforge.net/tools.html
    remove all
http://allura.sourceforge.net/platform.html
    s/why there are there./why they...
    s/(including me) //
    s/supper/super/
    "Pluggable Event Listeners¶"
        delete
http://allura.sourceforge.net/guides/message_bus.html
    change when changed
http://allura.sourceforge.net/guides/email.html
    delete "The html2text tool ............. metadata in e-mail message bodies."
    delete Spam¶
http://allura.sourceforge.net/guides/markup.html
    change to a paragraph within another page, and mention the syntax help/examples within allura
http://allura.sourceforge.net/guides/permissions.html
    s/both users and groups / groups/
    s/admin_users//
    delete
        Tools are encouraged to prefix their permissions with the tool name, so for a tool called “tracker” a good permission name would be tracker_edit_ticket.
    Individual artifacts and ACL’s¶
        add that this is mostly a platform service, and not exposed as a UI in the current tools
copyright 2011, the Allura Team
s/v0.1//

Tickets: ~~#151~~

Dave Brondsema - 2011-03-18

status: open --> in-progress

assigned_to: Dave Brondsema
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Dave Brondsema - 2011-03-18

status: in-progress --> code-review

assigned_to: Dave Brondsema --> Jenny Steele
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Dave Brondsema - 2011-03-18

forge:db/1558

I've published the docs at http://allura.sourceforge.net/

I guess just do a quick look through and make sure I didn't miss anything?

I don't think you need to review the whole diff
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Jenny Steele - 2011-03-22

status: code-review --> closed
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Apache Allura™

Forge software for hosting software projects

Milestone

Searches

Help

#1558 Update sphinx docs in Allura/docs/

Discussion

Related