0001463: Documentation required on how to contribute to the ardour manual - MantisBT

MantisBT

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

ID

Project

Category

View Status

Date Submitted

Last Update

0001463

ardour

documentation

public

2007-02-03 22:28

2017-05-17 01:18

Reporter

timbyr

Assigned To

timbyr

Priority

high

Severity

major

Reproducibility

N/A

Status

closed

Resolution

fixed

Platform

OS

OS Version

Product Version

Target Version

Fixed in Version

Summary

0001463: Documentation required on how to contribute to the ardour manual

Description

The Ardour manual has been converted to DocBook and some documentation should be available on how to contribute. This documentation should cover at least:

- What dependencies are required to convert the DocBook source into various formats(only XHTML at this stage) and how to do it.

- The basics of the DocBook format or links to existing documentation.

- Any specific usage of DocBook tags such as using recursive <section> tags vs <sect1-5> etc.

- Add a help target to the build system(A Makefile for now)

Tags

No tags attached.

Relationships

Notes
(0003169) timbyr (developer) 2007-02-04 17:55	Perhaps this information should be placed in the appendix of the manual in a Contributing section.

(0003172) timbyr (developer) 2007-02-04 19:53	It should also include guidelines for screenshots and diagrams, for instance: Screenshots: - file format - platform - window decoration theme/etc - size - subpixel aa/filtering Diagrams: - file format - size - palette - fonts

(0003194) timbyr (developer) 2007-02-07 21:03 edited on: 2007-02-08 02:51	References to style guidelines that closely match the manual style that we(I'm not sure who 'we' is at this point) would like to adhere to. some possible ideas/candidates: Gnome Documentation Style Guide (http://developer.gnome.org/projects/gdp/styleguide.html [^]) which is 404 at the moment. The Style chapter of the Fedora Documentation Guide. http://fedora.redhat.com/docs/documentation-guide/ [^] Others...?

(0019718) Headwar (reporter) 2017-05-17 01:18	https://github.com/Ardour/manual [^]

Issue History
Date Modified	Username	Field	Change
2007-02-03 22:28	timbyr	New Issue
2007-02-04 16:06	timbyr	Status	new => assigned
2007-02-04 16:06	timbyr	Assigned To	=> timbyr
2007-02-04 17:55	timbyr	Note Added: 0003169
2007-02-04 19:53	timbyr	Note Added: 0003172
2007-02-07 21:03	timbyr	Note Added: 0003194
2007-02-07 21:04	timbyr	Priority	normal => high
2007-02-08 02:51	timbyr	Note Edited: 0003194
2017-05-17 01:18	Headwar	Note Added: 0019718
2017-05-17 01:18	Headwar	Status	assigned => closed
2017-05-17 01:18	Headwar	Resolution	open => fixed

Copyright © 2000 - 2017 MantisBT Team