Re: documentation improvements

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Setting up a call to discuss this further and finalize an initial plan.

Location: https://bluejeans.com/2322394415
Time: September 28, 2018, 9.00-9:30 AM, PT

Please feel free to join this discussion.

Thanks,
Neha

On Wed, Sep 26, 2018 at 11:20 AM, Noah Watkins <noahwatkins@xxxxxxxxx> wrote:
> On Tue, Sep 25, 2018 at 1:57 PM Erwan Velu <evelu@xxxxxxxxxx> wrote:
>>
>> If that is possible, I would be lovely to get fixed URLs to reach {some}
>> configuration items.
>>
>> This way, it would be possible to have links between a versionned GUI
>> and its associated versionned documentation.
>
> Erwan,
>
> I did a little investigating on this suggestion yesterday. It appears
> that we can (1) mark settings/configuration items in the documentation
> with a semantic name, and (2) use write a basic Sphinx plugin to
> generate a URL map of these items when the documentation is built. I
> can see it looking something like a JSON file, say
> `ceph-docs-map-v13.2.1.json` containing a section that maps a term to
> a URL. This strategy is convenient because it places very little
> burden on maintaining those permalinks correctly other than just
> tagging configuration settings. Would something like that work? I
> suppose there are other strategies too.



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux