[jira] [Commented] (CASSANDRA-12449) Docs: Cassandra Development Section
[ https://issues.apache.org/jira/browse/CASSANDRA-12449?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15433325#comment-15433325 ] Stefan Podkowinski commented on CASSANDRA-12449: Changes look fine, please go ahead. > Docs: Cassandra Development Section > --- > > Key: CASSANDRA-12449 > URL: https://issues.apache.org/jira/browse/CASSANDRA-12449 > Project: Cassandra > Issue Type: Improvement > Components: Documentation and Website >Reporter: Stefan Podkowinski >Assignee: Stefan Podkowinski > > The new documentation already contains some user specific topics, but details > on developing Cassandra are still missing. I'd like to create a new > "Cassandra Development" section that would be initially created based on the > following content: > * [How to contribute|https://wiki.apache.org/cassandra/HowToContribute] > (should probably be split up into sub pages) > * [~iamaleksey]'s [On how to submit patches and have Cassandra committers > like > you|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1] > (some overlapping content with "How to contribute" here) > * [Code Style|https://wiki.apache.org/cassandra/CodeStyle] > * [Running Cassandra in > IDEA|https://wiki.apache.org/cassandra/RunningCassandraInIDEA] / [Running > Cassandra in > Eclipse|https://wiki.apache.org/cassandra/RunningCassandraInEclipse] (needs > to be reviewed for latest IDE versions) > Additional content would be nice to have as well, e.g. on contributing > documentation. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (CASSANDRA-12449) Docs: Cassandra Development Section
[ https://issues.apache.org/jira/browse/CASSANDRA-12449?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15433261#comment-15433261 ] Tyler Hobbs commented on CASSANDRA-12449: - This is great! Thank you _very_ much. Overall, this looks excellent to me. I've pushed a few minor fixes and tweaks to [a branch|https://github.com/thobbs/cassandra/tree/CASSANDRA-12449-review]. If you don't have anything else you'd like to add, I'll go ahead and commit this with those fixes. > Docs: Cassandra Development Section > --- > > Key: CASSANDRA-12449 > URL: https://issues.apache.org/jira/browse/CASSANDRA-12449 > Project: Cassandra > Issue Type: Improvement > Components: Documentation and Website >Reporter: Stefan Podkowinski >Assignee: Stefan Podkowinski > > The new documentation already contains some user specific topics, but details > on developing Cassandra are still missing. I'd like to create a new > "Cassandra Development" section that would be initially created based on the > following content: > * [How to contribute|https://wiki.apache.org/cassandra/HowToContribute] > (should probably be split up into sub pages) > * [~iamaleksey]'s [On how to submit patches and have Cassandra committers > like > you|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1] > (some overlapping content with "How to contribute" here) > * [Code Style|https://wiki.apache.org/cassandra/CodeStyle] > * [Running Cassandra in > IDEA|https://wiki.apache.org/cassandra/RunningCassandraInIDEA] / [Running > Cassandra in > Eclipse|https://wiki.apache.org/cassandra/RunningCassandraInEclipse] (needs > to be reviewed for latest IDE versions) > Additional content would be nice to have as well, e.g. on contributing > documentation. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (CASSANDRA-12449) Docs: Cassandra Development Section
[
https://issues.apache.org/jira/browse/CASSANDRA-12449?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15430551#comment-15430551
]
Stefan Podkowinski commented on CASSANDRA-12449:
I'm now done creating the documents. The [pages rendered on
github|https://github.com/spodkowinski/cassandra/tree/WIP-12449/doc/source/development]
can lack some details, so I'd suggest to checkout my [WIP
branch|https://github.com/spodkowinski/cassandra/tree/WIP-12449] instead and
generate the docs locally (install sphinx, run {{make html}} in docs directory).
So far I've
* Recreated most of the Eclipse related content, as the wiki page was totally
outdated
* Consolidated build instructions with IDE (IntelliJ+Eclipse) content on single
page, as the ant+IntelliJ instructions and very brief anyway
* Converted code-style and how-to review page to restructured markup
* Mostly rewrote testing instructions to give a bigger picture and link
external content for further instructions
* Converted [~iamaleksey]'s
[doc|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1#]
to separate "how-to commit" document intended for committers
* Created page to describe how to contribute code changes with a mix of new
content, [HowToContribute|https://wiki.apache.org/cassandra/HowToContribute]
and [AY's
doc|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1#]
Let me know if you have any further suggestions.
> Docs: Cassandra Development Section
> ---
>
> Key: CASSANDRA-12449
> URL: https://issues.apache.org/jira/browse/CASSANDRA-12449
> Project: Cassandra
> Issue Type: Improvement
> Components: Documentation and Website
>Reporter: Stefan Podkowinski
>Assignee: Stefan Podkowinski
>
> The new documentation already contains some user specific topics, but details
> on developing Cassandra are still missing. I'd like to create a new
> "Cassandra Development" section that would be initially created based on the
> following content:
> * [How to contribute|https://wiki.apache.org/cassandra/HowToContribute]
> (should probably be split up into sub pages)
> * [~iamaleksey]'s [On how to submit patches and have Cassandra committers
> like
> you|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1]
> (some overlapping content with "How to contribute" here)
> * [Code Style|https://wiki.apache.org/cassandra/CodeStyle]
> * [Running Cassandra in
> IDEA|https://wiki.apache.org/cassandra/RunningCassandraInIDEA] / [Running
> Cassandra in
> Eclipse|https://wiki.apache.org/cassandra/RunningCassandraInEclipse] (needs
> to be reviewed for latest IDE versions)
> Additional content would be nice to have as well, e.g. on contributing
> documentation.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (CASSANDRA-12449) Docs: Cassandra Development Section
[ https://issues.apache.org/jira/browse/CASSANDRA-12449?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15419086#comment-15419086 ] Tyler Hobbs commented on CASSANDRA-12449: - +1, this is a great idea. > Docs: Cassandra Development Section > --- > > Key: CASSANDRA-12449 > URL: https://issues.apache.org/jira/browse/CASSANDRA-12449 > Project: Cassandra > Issue Type: Improvement > Components: Documentation and Website >Reporter: Stefan Podkowinski >Assignee: Stefan Podkowinski > > The new documentation already contains some user specific topics, but details > on developing Cassandra are still missing. I'd like to create a new > "Cassandra Development" section that would be initially created based on the > following content: > * [How to contribute|https://wiki.apache.org/cassandra/HowToContribute] > (should probably be split up into sub pages) > * [~iamaleksey]'s [On how to submit patches and have Cassandra committers > like > you|https://docs.google.com/document/d/1d_AzYQo74de9utbbpyXxW2w-b0__sFhC7b24ibiJqjw/edit?pref=2=1] > (some overlapping content with "How to contribute" here) > * [Code Style|https://wiki.apache.org/cassandra/CodeStyle] > * [Running Cassandra in > IDEA|https://wiki.apache.org/cassandra/RunningCassandraInIDEA] / [Running > Cassandra in > Eclipse|https://wiki.apache.org/cassandra/RunningCassandraInEclipse] (needs > to be reviewed for latest IDE versions) > Additional content would be nice to have as well, e.g. on contributing > documentation. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
