You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Shai Erera <se...@gmail.com> on 2014/07/29 12:25:08 UTC
How to edit the Solr ref guide
Hi
I was reading some sections in the Solr ref guide and found few typos,
errors etc. How can I edit it? Do I need a user/pass for the confluence
website? I tried to login w/ my ASF credentials but it says my username is
not recognized.
Is it better to handle all these through JIRA. And if so, what's the
process in terms of text suggestions - can I generate a DIFF somehow?
Shai
Re: How to edit the Solr ref guide
Posted by Chris Hostetter <ho...@fucit.org>.
: I was reading some sections in the Solr ref guide and found few typos,
: errors etc. How can I edit it? Do I need a user/pass for the confluence
: website? I tried to login w/ my ASF credentials but it says my username is
: not recognized.
https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation
https://cwiki.apache.org/confluence/display/solr/Internal+-+CWIKI+ACLs
TR;DL:
* As a committer, create a cwiki acount, and post your username here
(or find me in IRC) and we can give you edit permissions
* non-committers who want to point out simple syggestions/typos usually
use the comments on the specific page, or open a jira to submit large
amounts of new documentation (w/ or w/o formatting)
-Hoss
http://www.lucidworks.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: How to edit the Solr ref guide
Posted by Shai Erera <se...@gmail.com>.
>
> I've added your edit permissions.
>
Thanks Hoss. I will follow the process. I was thinking more to improve the
documentation around the merge policy (and typos I find as I read the
guide), which means editing existing pages.
Shai
On Wed, Jul 30, 2014 at 8:03 PM, Chris Hostetter <ho...@fucit.org>
wrote:
>
> : OK thanks. I subscribed with the user 'shaie' (name: Shai Erera).
>
> I've added your edit permissions.
>
> : I will fix trivial typos and wording stuff directly there, and if
> there's a
> : bigger change I'll open JIRA issues.
>
> For edits to existing pages, feel free to make them directly. If you're
> talking about wanting to create big hunks of new content, but not being
> sure where to put them -- we actaully have a staging area for stuff like
> that...
>
>
> https://cwiki.apache.org/confluence/display/solr/Internal+-+Trunk+Changes+to+Document
>
> As evident by the name & intro on the page it was created as a place to
> document stuff on trunk so it would be ready to go when 5.0 comes out.
>
> but you can also use it to stage changes (already formated in the wiki
> editor) that should go in a 4.x release of the ref guide, but you aren't
> sure where exactly it makes the most sense yet.
>
>
>
> -Hoss
> http://www.lucidworks.com/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: How to edit the Solr ref guide
Posted by Chris Hostetter <ho...@fucit.org>.
: OK thanks. I subscribed with the user 'shaie' (name: Shai Erera).
I've added your edit permissions.
: I will fix trivial typos and wording stuff directly there, and if there's a
: bigger change I'll open JIRA issues.
For edits to existing pages, feel free to make them directly. If you're
talking about wanting to create big hunks of new content, but not being
sure where to put them -- we actaully have a staging area for stuff like
that...
https://cwiki.apache.org/confluence/display/solr/Internal+-+Trunk+Changes+to+Document
As evident by the name & intro on the page it was created as a place to
document stuff on trunk so it would be ready to go when 5.0 comes out.
but you can also use it to stage changes (already formated in the wiki
editor) that should go in a 4.x release of the ref guide, but you aren't
sure where exactly it makes the most sense yet.
-Hoss
http://www.lucidworks.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: How to edit the Solr ref guide
Posted by Shai Erera <se...@gmail.com>.
OK thanks. I subscribed with the user 'shaie' (name: Shai Erera).
I will fix trivial typos and wording stuff directly there, and if there's a
bigger change I'll open JIRA issues.
Shai
On Tue, Jul 29, 2014 at 6:34 PM, Steve Rowe <sa...@gmail.com> wrote:
>
> On Jul 29, 2014, at 10:45 AM, Steve Rowe <sa...@gmail.com> wrote:
>
> > Historically, ref guide edits have been RTC - you can always see a diff
> of previous changes from each page (click on the “view change” link under
> the title of each page).
>
> Crap, that should be CTR (commit first, ask questions later).
>
> Steve
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: How to edit the Solr ref guide
Posted by Steve Rowe <sa...@gmail.com>.
On Jul 29, 2014, at 10:45 AM, Steve Rowe <sa...@gmail.com> wrote:
> Historically, ref guide edits have been RTC - you can always see a diff of previous changes from each page (click on the “view change” link under the title of each page).
Crap, that should be CTR (commit first, ask questions later).
Steve
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: How to edit the Solr ref guide
Posted by Steve Rowe <sa...@gmail.com>.
Hi Shai,
On Jul 29, 2014, at 6:25 AM, Shai Erera <se...@gmail.com> wrote:
> I was reading some sections in the Solr ref guide and found few typos, errors etc. How can I edit it? Do I need a user/pass for the confluence website? I tried to login w/ my ASF credentials but it says my username is not recognized.
Info here about how it’s set up: <https://cwiki.apache.org/confluence/display/solr/Internal+-+CWIKI+ACLs> - in short, you need a separate set of credentials for Confluence, and for another committer with permissions to grant your Confluence account permissions on the Solr ref guide space.
> Is it better to handle all these through JIRA. And if so, what's the process in terms of text suggestions - can I generate a DIFF somehow?
Historically, ref guide edits have been RTC - you can always see a diff of previous changes from each page (click on the “view change” link under the title of each page).
Steve
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org