Release Procedure: Text Files, Documentation and PR: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
 
(12 intermediate revisions by 2 users not shown)
Line 2: Line 2:


==Updating text files in the source tree==
==Updating text files in the source tree==
README


==Updating documentation files==
==Updating documentation files==
Line 11: Line 12:
specs.html is a complex HTML file and should be edited with LibreOffice Writer Web.
specs.html is a complex HTML file and should be edited with LibreOffice Writer Web.


Depending on new/altered/removed features, documentations files, as well as the content.xml file, may require updates or removals.
Depending on new/altered/removed features, documentation files, as well as the content.xml file, may require updates or removals.


==Creating and uploading PDF data sheet==
==Creating and uploading PDF data sheet==
The data sheet is a PDF version of specs.html. It should be uploaded to the Wiki and be linked to in the announcement.
The data sheet is a PDF version of specs.html. It should be uploaded to the Wiki and be linked to in the announcement. (Use LibreOffice)


==Creating a Wiki page==
==Creating a Wiki page==
 
# Update https://www.scribus.net/downloads/stable-branch/ (if applicable)
==Updating the website==
# Update https://www.scribus.net/downloads/unstable-branch/ (if applicable)
# Add a short article to the "Latest Announcements" section (https://www.scribus.net/category/news/), including a screenshot of the current splash screen or another meaningful screenshot and a link to the full announcement on the Wiki.


==Updating the Wiki==
==Updating the Wiki==
# Update the specific Stable (1.4.x) and Developmental (1.5.x) pages on the wiki (See [[https://wiki.scribus.net/canvas/Release_Procedure:_Text_Files,_Documentation_and_PR#Creating_a_Wiki_page]])
# Update [[Announcements]] with above 1.4.x and 1.5.x links
# Update [[Template:Stable-version]] with new Stable version number and link to sourceforge
# Update [[Template:Developmental-version]] with a new Developmental version number and a link to Sourceforge


==Getting the message out==
==Getting the message out==
Send out the release notes from the Wiki page minus the logos and in plain text form to the recipients (partners, potential multipliers, press) in the distribution list (currently handled by Christoph). Be careful to separate the three categories, in other words: send one email to all press contacts (using CC or BCC), one to partners etc.
# Send out the release notes from the Wiki page minus the logos and in plain text form to the recipients (partners, potential multipliers, press) in the distribution list (currently handled by Christoph). Be careful to separate the three categories, in other words: send one email to all press contacts (using CC or BCC), one to partners etc.
# Social Media: g+
# Social Media: twitter


==Updating external resources==
==Updating external resources==
The most important external resource that needs to be updated is Wikipedia. Note that many of Wikipedia's Scribus pages haven't been updated for years, but some are up to date, especially the major ones (English, German, French, Italian etc.).
The most important external resource that needs to be updated is Wikipedia. Note that many of Wikipedia's Scribus pages haven't been updated for years, but some are up to date, especially the major ones (English, German, French, Italian etc.).

Latest revision as of 06:08, 11 May 2016


Updating text files in the source tree

README

Updating documentation files

Some doc files need to be updated and translated for every new release, most notably:

  • specs.html
  • readme.html
  • releases.html

specs.html is a complex HTML file and should be edited with LibreOffice Writer Web.

Depending on new/altered/removed features, documentation files, as well as the content.xml file, may require updates or removals.

Creating and uploading PDF data sheet

The data sheet is a PDF version of specs.html. It should be uploaded to the Wiki and be linked to in the announcement. (Use LibreOffice)

Creating a Wiki page

  1. Update https://www.scribus.net/downloads/stable-branch/ (if applicable)
  2. Update https://www.scribus.net/downloads/unstable-branch/ (if applicable)
  3. Add a short article to the "Latest Announcements" section (https://www.scribus.net/category/news/), including a screenshot of the current splash screen or another meaningful screenshot and a link to the full announcement on the Wiki.

Updating the Wiki

  1. Update the specific Stable (1.4.x) and Developmental (1.5.x) pages on the wiki (See [[1]])
  2. Update Announcements with above 1.4.x and 1.5.x links
  3. Update Template:Stable-version with new Stable version number and link to sourceforge
  4. Update Template:Developmental-version with a new Developmental version number and a link to Sourceforge

Getting the message out

  1. Send out the release notes from the Wiki page minus the logos and in plain text form to the recipients (partners, potential multipliers, press) in the distribution list (currently handled by Christoph). Be careful to separate the three categories, in other words: send one email to all press contacts (using CC or BCC), one to partners etc.
  2. Social Media: g+
  3. Social Media: twitter

Updating external resources

The most important external resource that needs to be updated is Wikipedia. Note that many of Wikipedia's Scribus pages haven't been updated for years, but some are up to date, especially the major ones (English, German, French, Italian etc.).