Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [asciidoc-lang-dev] AsciiDoc Language project kickoff

All sounds logical to me. 

It will give us all something to chip away at together. A bit of a unifying docs jam around an open (source) fire.

Jared Morgan
M: +61413005479




On Wed, 17 Feb 2021 at 18:32, Dan Allen <dan@xxxxxxxxxxxxxx> wrote:
On Tue, Feb 16, 2021 at 10:35 PM Jared Morgan <jaredleonmorgan@xxxxxxxxx> wrote:
Sounds like something I could help with.

We'd definitely appreciate you lending a hand. Thanks!
 

Perhaps in another thread you could elaborate on the scope of any docs review tasks.

Absolutely. First, there are some lingering issues from the originating repository (asciidoc-docs) that need to get ported over. See https://github.com/asciidoctor/asciidoc-docs/issues And we'll also need to comb through the documentation-related issues filed against asciidoctor.org and determine which of those are still relevant and need to be carried forward. (You may recall filing some of those issues). Feel free to comment on the issues you think are still outstanding and I'll transfer the issue.


It sounds like this is less about churning though bugs, and more about reviewing and creating a backlog of work to socialise the proposed fixes so committers can help share the load.

I'd say it's a bit of both. And we definitely don't want the work to fall on any one person's shoulders, so share it is indeed!

Sarah, myself, and others did our best to extract the documentation pertaining to the AsciiDoc Language from the Asciidoctor user manual cleanly and accurately, but it left some gaps. Some of those gaps were due to the documentation missing in the first place (which is now far more apparent). Others may have been errors introduced in rephrasing or loss of surrounding context. And then there's just the good old typos and grammar errors. So it does still need a bit of grooming.

I collected about a dozen or so notes while doing the last review that I need to report as issues. I'll work on filing those later this week or next. But don't be afraid to use the issue tracker if you see things that need to be reported. Just make sure that the issue is clear and achievable. (Focused issues are better that broad ones).

Best Regards,

-Dan

--
Dan Allen, Vice President | OpenDevise Inc.
Pronouns: he, him, his
Content ∙ Strategy ∙ Community
opendevise.com
_______________________________________________
asciidoc-lang-dev mailing list
asciidoc-lang-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/asciidoc-lang-dev

Back to the top