I've just made my first edit of the new AsciiDoc reference guide. It's about 10,000 times easier than editing the CWiki. Every time I had to edit the CWiki I put it off because I found it...painful. I don't have that excuse any more.
So listen up foks ;). There's one less excuse for not editing the ref guide as part of the normal process of submitting JIRAs. Cassandra and Hoss have done yeoman's duty converting the old ref guide to the new format, they deserve a _lot_ of applause. Newbie notes: 0> The raw files live in solr>>solr-ref-guide>>src 1> These are now just files that are part of the project. Can be edited/checked in with the patch. Hint. Hint. Hint. 1.1> Since they only live locally before being pushed, you can work on them incrementally. 1.2> Checking them in follows the same rules as normal JIRAs, you need to push the change in all relevant branches. 2> At least intelliJ has a nifty plugin that lets you see the effects as you type. Highly recommended. I'd guess other IDEs have one too. Minor nits about the plugin: it takes a bit to find the "soft wrap": `View>>active editor>>use soft wraps`. The raw file must have the focus to find this option. And I haven't yet found out how to split the screen horizontally rather than vertically between the raw and formatted view. 3> Solr>>solr-ref-guide>>meta-docs has instructions. See particularly asciidoc-syntax.adoc and editing-tools.adoc your first time in. 4> I don't think minor edits require a JIRA, larger ones maybe. Pretty much just like the CWiki I suppose. Erick --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
