[wildfly-dev] Wildscribe Documentation

[James Perkins]

On Wed, Feb 19, 2020 at 3:05 AM Darran Lofthouse <darran.lofthouse at jboss.com>
wrote:

> WildScribe is the kind of thing that could be generated and pushed
> somewhere within a GitHub action.
>

The biggest question is where to push it. I'd like to get away from the
current index page we have now as the links for versions are going off the
screen. At least for me :).

OT for this specific subject, but I would like seeing the docs as a
separate project so we could do that. That would definitely be a good fit
for GitHub Actions.


>
> On Tue, Feb 18, 2020 at 7:29 PM Brian Stansberry <
> brian.stansberry at redhat.com> wrote:
>
>> So AIUI once we do this, the https://wildscribe.github.io/ site will get
>> no further updates for WF, and the text in the middle will be updated to
>> note that model reference docs for later versions can now be found on
>> docs.wildfly.org, probably with an example link to
>> docs.wildfly.org/19/#model-reference page.
>>
>> Which sounds fine.
>>
>> On Tue, Feb 18, 2020 at 12:10 PM James Perkins <jperkins at redhat.com>
>> wrote:
>>
>>> Hello All,
>>> It's been some time since I brought up adding the Wildscribe
>>> documentation to the WildFly docs. I've got a draft PR
>>> <https://github.com/wildfly/wildfly/pull/12934> up [1] which implements
>>> this idea. You can see the results at
>>> https://jamezp.github.io/wildfly.github.io/19/#model-reference.
>>>
>>> Does anyone have any concerns or further ideas about adding the
>>> Wildscribe documentation do docs.wildfly.org? Any input is welcome.
>>>
>>> [1]: https://github.com/wildfly/wildfly/pull/12934
>>>
>>> On Fri, Nov 1, 2019 at 12:17 PM James Perkins <jperkins at redhat.com>
>>> wrote:
>>>
>>>> Hello All,
>>>> I assume everyone is aware of what Wildscribe [1] is. I've had a
>>>> thought that instead of having this massive site that will keep growing
>>>> with each version of WildFly released that we start adding this model
>>>> documentation on the WildFly Documentation site [2]. The idea is to just
>>>> add a link on each releases index page with a link to the model
>>>> descriptions.
>>>>
>>>> This would be automated as well with the docs project within WildFly.
>>>> It means that as part of the release process when building the docs the
>>>> Wildscribe model pages would be generated automatically.
>>>>
>>>> My proposal would be for WildFly 19+ we would no longer update the
>>>> Wildscribe website. As you can see on the site if you click on versions
>>>> it's getting quite long :). All new Wildsribe pages would be present on the
>>>> main documentation for that version. The Wildscribe site would have a note
>>>> about where the documentation would now be for newer releases.
>>>>
>>>> Any thoughts or concerns about this? If not objections I'll file a JIRA
>>>> and do some work on this as it shouldn't take all that long.
>>>>
>>>> [1]: https://wildscribe.github.io/
>>>> [2]: https://docs.wildfly.org
>>>>
>>>> --
>>>> James R. Perkins
>>>> JBoss by Red Hat
>>>>
>>>
>>>
>>> --
>>> James R. Perkins
>>> JBoss by Red Hat
>>> _______________________________________________
>>> wildfly-dev mailing list
>>> wildfly-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/wildfly-dev
>>
>>
>>
>> --
>> Brian Stansberry
>> Manager, Senior Principal Software Engineer
>> Red Hat
>> _______________________________________________
>> wildfly-dev mailing list
>> wildfly-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/wildfly-dev
>
>

-- 
James R. Perkins
JBoss by Red Hat
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/wildfly-dev/attachments/20200219/603580e7/attachment.html