You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by GitBox <gi...@apache.org> on 2021/04/09 19:16:53 UTC
[GitHub] [solr] epugh opened a new pull request #69: SOLR-12930: Simplify and Organize Developer Docs
epugh opened a new pull request #69:
URL: https://github.com/apache/solr/pull/69
There is an existing SOLR-12930 that is open, and I hope to close it by finishing up consolidating the docs.
# Description
Developer documentation (and related scripts) are spread over a number of locations:
`/dev-docs`
`/solr/dev-docs`
`/solr/cloud-dev`
`/dev-tools`
`/help`
# Solution
This PR consolidates `/solr/dev-docs` into the top level `/dev-docs`, moves the `cloud.sh` into the existing `/dev-tools`.
I also ended up doing some light editing of the documentation as well.
# Tests
I ran the `./gradlew assemble` and it works the same, i also ran the `cloud.sh` script.
# Checklist
Please review the following and check all that apply:
- [X ] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ X] I have created a Jira issue and added the issue ID to my pull request title.
- [ X] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [ X] I have developed this patch against the `main` branch.
- [ X] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611679952
##########
File path: dev-docs/README.adoc
##########
@@ -16,6 +16,16 @@
// specific language governing permissions and limitations
// under the License.
-This directory includes information for the Lucene project overall.
+This directory includes information for Solr developers. There are some other
+sources of information for learning about developing on Solr:
-Also look in `lucene/dev-docs` for Lucene developer information and `solr/dev-docs` for Solr developer information.
+1. The help .txt files for the Gradle commands in the `help/` directory.
+
+2. Information on how to handle adding dependencies and related licensing
Review comment:
+1.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611677684
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
+
+=== What do I do with NOTICE.txt if I don't have one to satisfy Gradle?
+
+You create a empty file, similar to the `/solr/licenses/antlr4-runtime-NOTICE.txt`
Review comment:
Fair enough! I never think to just fix this stuff myself, but it's easy enough and I don't mind. Thanks for the invite.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611591540
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
Review comment:
Check out how I reworked this page. I think having more pointers/cross referencing is a good thing!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611680467
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
Review comment:
LGTM!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611576150
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
Review comment:
I was talking to Hoss about this NOTICE.txt situation, and he pointed out that there's a README in `solr/licenses`, and since it already exists that's prob the ideal place to document this.
I was going to push up a PR this morning with two changes:
- add information to the README to cover some of the gaps in adding a dependency
- mention the README specifically in `help/dependencies.txt` so that devs know that it exists and where to look it up for more info.
That's not to say that this couldn't also be covered as a FAQ item. Maybe it still makes sense to mention here. Just wanted to let you know that I intend to cover it elsewhere shortly in case that changes your mind on having it here.
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
+
+=== What do I do with NOTICE.txt if I don't have one to satisfy Gradle?
+
+You create a empty file, similar to the `/solr/licenses/antlr4-runtime-NOTICE.txt`
Review comment:
[0] Not sure if you're looking for grammar edits at this point, but I'll leave them and you can choose to ignore if you want.
"a empty file" -> "an empty file".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611592143
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
+
+=== What do I do with NOTICE.txt if I don't have one to satisfy Gradle?
+
+You create a empty file, similar to the `/solr/licenses/antlr4-runtime-NOTICE.txt`
Review comment:
Thanks... BTW, in the future, if you want to edit my PR's, please do! I also appreciate the detailed comments you leave me!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh merged pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
epugh merged pull request #69:
URL: https://github.com/apache/solr/pull/69
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] gerlowskija commented on a change in pull request #69: SOLR-12930: Simplify and Organize Developer Docs
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on a change in pull request #69:
URL: https://github.com/apache/solr/pull/69#discussion_r611686440
##########
File path: dev-docs/FAQ.adoc
##########
@@ -0,0 +1,11 @@
+= Frequently Asked Questions
+:toc: left
+
+
+== FAQ
+
+This document provides a quick reference for frequently questioned concepts and features in Credentials.
Review comment:
(Here's the PR I mentioned above, in case you're curious: https://github.com/apache/solr/pull/72)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org