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/06/23 18:29:57 UTC
[GitHub] [solr] ctargett opened a new pull request #190: SOLR-14444: Ref Guide re-organization
ctargett opened a new pull request #190:
URL: https://github.com/apache/solr/pull/190
https://issues.apache.org/jira/browse/SOLR-14444
# Description
This PR overhauls the entire Ref Guide in several major ways:
- New organizational structure
- Renamed and removed several pages
- Split the Solr Tutorial
- Standardized SolrCloud/standalone/legacy/leader-follower terminology
- Introduced several new formatting elements and approaches
See the wiki page for discussion of all the changes: https://cwiki.apache.org/confluence/display/SOLR/Ref+Guide+Re-Org+2021
--
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] janhoy commented on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
janhoy commented on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-868286935
I created https://issues.apache.org/jira/browse/SOLR-15497 for the broken links
--
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 edited a comment on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
gerlowskija edited a comment on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-870154214
This LGTM and is a huge step forward for the ref-guide!
The biggest nitpick I probably have here is that the breaking up of the old "Admin UI" section (a change I'm hugely in favor of) leaves a few vestigial stub pages around as not very useful "screenshot-vehicles". e.g. thread-dump.adoc. It looks like most of the Admin UI content it looks like was able to be pulled into other pages, but the few places this couldn't be done feel awkward IMO.
Not sure there's a fix to this though - short of individually adding conceptually related content to these pages. (In the thread-dump.adoc example, maybe someone will eventually add info there about Solr-specific things to look for in thread dumps). That said, I'm totally happy to live with this if it's a side effect of the otherwise overwhelmingly positive change.
Will be great to see this in 9!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
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] ctargett commented on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
ctargett commented on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-867835788
> The -prerelease5 suffix should probably not be there (and will not either of course in the final release), not sure if it needs change.
No, they shouldn't need to change. The Lucene version comes from `versions.props` so when that's right for 9.0 it will be right in the 9.0 Ref Guide. This has been true forever - the URL is always wrong until the javadocs exist.
> Here is the list of broken links
I didn't change anything here, so presumably these are also all 40x in the current Ref Guide. I'm not sure how fixing them relates to approving the overall content re-organization? One could fix them all in the current Ref Guide in `main` right now, or pre-9.0 release, and in branch_8x, etc.
--
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 pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-870154214
This LGTM and is a huge step forward for the ref-guide!
The biggest nitpick I probably have here is that the breaking up of the old "Admin UI" section (a change I'm hugely in favor of) leaves a few vestigial stub pages around as not very useful "screenshot-vehicles". e.g. thread-dump.adoc. It looks like most of the Admin UI content it looks like was able to be pulled into other pages, but the few places this couldn't be done feel awkward IMO. Not sure there's a fix to this though - short of individually adding conceptually related content to these pages. (In the thread-dump.adoc example, maybe someone will eventually add info there about Solr-specific things to look for in thread dumps). That said, I'm totally happy to live with this if it's a side effect of the otherwise overwhelmingly positive change.
Will be great to see this in 9!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
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] janhoy commented on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
janhoy commented on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-867988538
Yep, let’s do the link fixes in a separate issue.
--
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 pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
gerlowskija commented on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-870154214
This LGTM and is a huge step forward for the ref-guide!
The biggest nitpick I probably have here is that the breaking up of the old "Admin UI" section (a change I'm hugely in favor of) leaves a few vestigial stub pages around as not very useful "screenshot-vehicles". e.g. thread-dump.adoc. It looks like most of the Admin UI content it looks like was able to be pulled into other pages, but the few places this couldn't be done feel awkward IMO. Not sure there's a fix to this though - short of individually adding conceptually related content to these pages. (In the thread-dump.adoc example, maybe someone will eventually add info there about Solr-specific things to look for in thread dumps). That said, I'm totally happy to live with this if it's a side effect of the otherwise overwhelmingly positive change.
Will be great to see this in 9!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
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 edited a comment on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
gerlowskija edited a comment on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-870154214
This LGTM and is a huge step forward for the ref-guide!
The biggest nitpick I probably have here is that the breaking up of the old "Admin UI" section (a change I'm hugely in favor of) leaves a few vestigial stub pages around as not very useful "screenshot-vehicles". e.g. thread-dump.adoc. It looks like most of the Admin UI content it looks like was able to be pulled into other pages, but the few places this couldn't be done feel awkward IMO.
Not sure there's a fix to this though - short of individually adding conceptually related content to these pages. (In the thread-dump.adoc example, maybe someone will eventually add info there about Solr-specific things to look for in thread dumps). That said, I'm totally happy to live with this if it's a side effect of the otherwise overwhelmingly positive change.
Will be great to see this in 9!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
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] ctargett merged pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
ctargett merged pull request #190:
URL: https://github.com/apache/solr/pull/190
--
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.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
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] ctargett edited a comment on pull request #190: SOLR-14444: Ref Guide re-organization
Posted by GitBox <gi...@apache.org>.
ctargett edited a comment on pull request #190:
URL: https://github.com/apache/solr/pull/190#issuecomment-867835788
> The -prerelease5 suffix should probably not be there (and will not either of course in the final release), not sure if it needs change.
No, they shouldn't need to change. The Lucene version comes from `versions.props` so when that's right for 9.0 it will be right in the 9.0 Ref Guide. This has been true forever - the URL is always wrong until the javadocs exist.
> Here is the list of broken links
I didn't change anything here, so presumably these are also all 40x in the current Ref Guide. I'm not sure how fixing them relates to approving the overall content re-organization? One could fix them all in the current Ref Guide in `main` right now, or pre-9.0 release, and in branch_8x, etc. (Edit to add: I did actually spot-check a couple from the 8.8 Guide and they are broken there, so this needs to be a separate issue IMO. And if we expect all Ref Guide edits to pass a link audit, then perhaps another separate issue should tackle adding that to the build process.)
--
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