Hey all,

As planned for the 3.5 release, I have moved the FEDORADEV space to
FEDORA35, so the in-development 3.5 documentation is now here:

https://wiki.duraspace.org/display/FEDORA35

>From this point forward, feature releases will have docs in their own
space, FEDORA[M][m], where M is the major version and m is the minor
version. Bug fix releases (e.g. 3.5.1) will have their docs done
directly in the point release's space...in many cases, just updating
the release notes and download links.

Anyway, after doing this, I went ahead and updated the docs in a few
ways and wanted to share what's been done so far:

* Switched to Confluence's "Documentation" theme, which puts a nice
hierarchy browser and search bar on the left. This is similar to what
we had before, but is a more standard/supported way of doing it in
Confluence.
* Followed Atlassian's example in linking to old versions of docs
right in this left nav area
* Started to "tame" some of the docs by making consistent use of
different heading levels (h1, h2, etc), tables of contents, and more.
* Started a "Documentation Style Guide"[1] for fcrepo docs that we can
use moving forward. I'm fine with making changes to this; I just think
it's important to have such a thing, so I took a stab at some basic
rules that we can follow when writing docs.
* Re-worked the top page and documentation hierarchy to make it easier
to browse through and find things. I think the structure makes quite a
bit more sense than before. Let me know what you think.

The bits that still need style "taming" are within the Client
Reference and Server Reference sections. Many of those docs are still
using inconsistent heading levels and various other style elements.

- Chris

[1] Documentation Style Guide
https://wiki.duraspace.org/display/FEDORA/Documentation+Style+Guide

------------------------------------------------------------------------------
AppSumo Presents a FREE Video for the SourceForge Community by Eric 
Ries, the creator of the Lean Startup Methodology on "Lean Startup 
Secrets Revealed." This video shows you how to validate your ideas, 
optimize your ideas and identify your business strategy.
http://p.sf.net/sfu/appsumosfdev2dev
_______________________________________________
Fedora-commons-developers mailing list
Fedora-commons-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/fedora-commons-developers

Reply via email to