You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cassandra.apache.org by Berenguer Blasi <be...@gmail.com> on 2021/08/09 07:29:44 UTC
Why skinny in-tree CQL docs?
Hi all,
working on CASSANDRA-13047 we noticed there's a skinny CQL help file
in-tree to where the 'help' command takes you to. This, iiuc, is to
support help on topics for envs with reduced connectivity where they
can't go online.
Is this correct? And shouldn't it be preferable to replace that skinny
page with a local copy of the CQL docs?
Thx in advance for your thoughts!
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cassandra.apache.org
For additional commands, e-mail: dev-help@cassandra.apache.org
Re: Why skinny in-tree CQL docs?
Posted by Berenguer Blasi <be...@gmail.com>.
Right we need to go through these when all that docs movement settles
down and decide what to do with CASSANDRA-13047 then. Docs being handy
and clear are super important imo.
On 11/8/21 12:36, Mick Semb Wever wrote:
>
>> I will join the loop in those tickets.
>>
>
> BTW it is great that you raised this. That light file in the patch for CASSANDRA-16763 been migrated to an adoc file, and now available on the website¹, and probably not what we want if we are not yet bundling docs into releases…
>
> [1] https://cassandra.apache.org/doc/latest/cassandra/cql/cql_singlefile.html
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@cassandra.apache.org
> For additional commands, e-mail: dev-help@cassandra.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cassandra.apache.org
For additional commands, e-mail: dev-help@cassandra.apache.org
Re: Why skinny in-tree CQL docs?
Posted by Mick Semb Wever <mc...@apache.org>.
> I will join the loop in those tickets.
>
BTW it is great that you raised this. That light file in the patch for CASSANDRA-16763 been migrated to an adoc file, and now available on the website¹, and probably not what we want if we are not yet bundling docs into releases…
[1] https://cassandra.apache.org/doc/latest/cassandra/cql/cql_singlefile.html
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cassandra.apache.org
For additional commands, e-mail: dev-help@cassandra.apache.org
Re: Why skinny in-tree CQL docs?
Posted by Berenguer Blasi <be...@gmail.com>.
Thx for the reply Mick,
I will join the loop in those tickets.
On 9/8/21 14:14, Mick Semb Wever wrote:
>> And shouldn't it be preferable to replace that skinny
>> page with a local copy of the CQL docs?
>>
>
> Our binaries don't ship with all-the-docs.
>
> This has been discussed during the work for the new website and its new
> antora build system: CASSANDRA-16761 and CASSANDRA-16763.
> That is, it would be nice to bundle a complete antora build of the in-tree
> docs in our binary releases.
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cassandra.apache.org
For additional commands, e-mail: dev-help@cassandra.apache.org
Re: Why skinny in-tree CQL docs?
Posted by Mick Semb Wever <mc...@apache.org>.
>
> And shouldn't it be preferable to replace that skinny
> page with a local copy of the CQL docs?
>
Our binaries don't ship with all-the-docs.
This has been discussed during the work for the new website and its new
antora build system: CASSANDRA-16761 and CASSANDRA-16763.
That is, it would be nice to bundle a complete antora build of the in-tree
docs in our binary releases.