[RTEMS Project] #2864: docs.rtems.org Automatic update of branches content when a rtems-doc.git change is made.

[RTEMS trac]

#2864: docs.rtems.org Automatic update of branches content when a rtems-doc.git
change is made.
---------------------------+-------------------
 Reporter:  chrisj         |       Owner:
     Type:  defect         |      Status:  new
 Priority:  high           |   Milestone:  4.12
Component:  Documentation  |     Version:  4.11
 Severity:  major          |  Resolution:
 Keywords:                 |
---------------------------+-------------------

Comment (by amar):

 Replying to [comment:4 chrisj]:

 > Release builds are part of the release process which is a separate from
 this web site. The released documents are loaded on the the web site and
 the website's configuration updated to include the release details and the
 site is regenerated.

 They'll all be built from the same location using the same tools and same
 process the only difference is one will be a tag and the other a branch.
 If you are talking about what 'triggers' a build then yes they are
 different.


 > For building from git I was told to sort out building by cron so this is
 what I have done.
 >
 > Is it possible to set up a share on the TrueNAS to be a clearing house
 between sync and docs?

 How long is this going to be setup for?  I suggested this before you
 mentioned building after every commit...


 > > It needs to be managed properly, most projects overwrite their 'devel'
 documentation with new versions.
 >
 > I am concerned it places extra stress on the limit resources we have so
 do not see holding builds as a priority. We have the source in git so
 someone can get that release and build it.

 Space isn't an issue it will be a decade worth of builds before it will be
 a problem.

 The other nice feature is if someone builds from a commit in source
 they'll have the corresponding documentation available that is as close to
 that version as possible -- I have a way to track this it's a tool I wrote
 some time ago.


 > >  I want to keep around every single built version for comparison this
 is more useful for contributors.
 >
 > How is this more useful for contributors?

 Not all errors are build errors some are formatting/syntax.  Lots of
 contributors don't have the ability to build docs from source -- I don't
 think that is a pre requisit to make changes since they need to be tested
 before commit anyway.

 Docs are unique in that regard.

--
Ticket URL: <http://devel.rtems.org/ticket/2864#comment:5>
RTEMS Project <http://www.rtems.org/>
RTEMS Project