[rtems-docs commit] c-user: Generate Timer Manager documentation

[Chris Johns]

On 15/12/20 5:39 pm, Sebastian Huber wrote:
> On 15/12/2020 05:08, Chris Johns wrote:
>>
>> On 11/12/20 5:02 pm, Sebastian Huber wrote:
>>> On 11/12/2020 01:35, Chris Johns wrote:
>>>>>> Suggestions?
>>>>> We could add a script which performs some post processing after creation
>>>>> the of
>>>>> the release branches.
>>>> What about ....
>>>>
>>>> https://www.rtems.org/support/bugs.html
>>>>
>>>> If a redirect can be set up we could insulate these links from the location
>>>> they
>>>> are.
>>> I don't mind changing the link and regenerate the sources, but I think changing
>>> the documentation links is not good in general.
>> Yes so do we stop adding invalid links? We either accept we need to change them
>> once we have something sorted or we do not added them until then?
>>
>> I do not have any other solutions and I am open to a better one.
>>
>> Not resolving this issue makes releasing hard and given the push back I received
>> for some changes I made at release time I would prefer we act when it happens
>> and acknowledge the liability.
> I still don't understand your urge to change the links in the comments
> immediately. These links point to valid pages currently. 

Valid? ... that seems like a point of view. The links point to development
builds of pages that describes the "current" process and by definition master
may change and may break. A release with the frozen code will point to those
same pages for ever and that is broken no matter where the links are, source,
comments or built and released documentation packages. The links should either
refer to pages for that release, a link that we declare is stable or no link but
a reference to chapter etc in a manual.

This is not an urge. I wish I did not have to bother but someone has too. These
things become an issue and I seem to have to deal with them over time, eg
releasing. The topic is hard and we need to address it.

> The
> 
> https://www.rtems.org/support/bugs.html
> 
> is a dead page right now. 

Yes but that can be fixed if this is the path we want to follow.

> Are there plans to move the documentation links?

Yes I think they may, I am not yet sure. The disk these files exist on is full
and so I am forced to move the documentation. I am looking at using the TrueNAS
storage. I do not know what the fall out of this move will be so yes URLs may
change. These links and things like it add complexity and pressure on me to make
these choices and I am wanting to mitigate doing that.

Chris