Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
epugh merged PR #5005: URL: https://github.com/apache/solr/pull/5005 -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] - To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
serhiy-bzhezytskyy commented on code in PR #5005:
URL: https://github.com/apache/solr/pull/5005#discussion_r4167962838
##
solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc:
##
@@ -73,6 +73,9 @@ As of the 7.2 version of this Guide, these examples are not
yet complete - more
The section xref:configuration-guide:v2-api.adoc[] provides more information
about how to work with the new API structure, including how to disable it if
you choose to do so.
+In URLs and paths, a name in curly braces, such as `\{collectionName}` or
`\{coreName}`, stands for a value you replace with your own.
Review Comment:
Opened https://github.com/apache/solr/pull/5008. A correction to what I
wrote above: `AGENTS.md` already lists `dev-docs/ref-guide/` in its Developer
Docs Index; what it lacked was a pointer from the Documentation bullet, which
that PR adds.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
serhiy-bzhezytskyy commented on code in PR #5005:
URL: https://github.com/apache/solr/pull/5005#discussion_r4167941964
##
solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc:
##
@@ -352,15 +352,15 @@ V1 API::
[source,bash]
-curl -X GET
"http://localhost:8983/solr/admin/cores?action=RENAME&core=currentCoreName&other=newCoreName";
+curl -X GET
"http://localhost:8983/solr/admin/cores?action=RENAME&core={currentCoreName}&other=newCoreName";
Review Comment:
The `-X GET` was already on those lines on main, so I took the change back
out of this PR; the 48 lines are in their own PR,
https://github.com/apache/solr/pull/5007. `-X PUT`, `DELETE` and `POST` stay
where they change the request.
##
solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc:
##
@@ -140,7 +140,7 @@ If the collection is named `collection1`, the package name
is `mypackage`, and t
[source,bash]
-curl "http://localhost:8983/api/collections/collection1/config/params"; \
+curl "http://localhost:8983/api/collections/{collectionName}/config/params"; \
Review Comment:
Right, that one already follows the rule.
##
solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc:
##
@@ -73,6 +73,9 @@ As of the 7.2 version of this Guide, these examples are not
yet complete - more
The section xref:configuration-guide:v2-api.adoc[] provides more information
about how to work with the new API structure, including how to disable it if
you choose to do so.
+In URLs and paths, a name in curly braces, such as `\{collectionName}` or
`\{coreName}`, stands for a value you replace with your own.
Review Comment:
`AGENTS.md` has a Documentation section that tells agents to update the
reference guide, but nothing there says how to write a page. I'll add a line
pointing at `dev-docs/ref-guide/asciidoc-syntax.adoc` and this page, as a
separate PR.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
epugh commented on PR #5005: URL: https://github.com/apache/solr/pull/5005#issuecomment-5957090324 Okay, once build finishes I'll merge! -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] - To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
epugh commented on code in PR #5005:
URL: https://github.com/apache/solr/pull/5005#discussion_r4167796346
##
solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc:
##
@@ -73,6 +73,9 @@ As of the 7.2 version of this Guide, these examples are not
yet complete - more
The section xref:configuration-guide:v2-api.adoc[] provides more information
about how to work with the new API structure, including how to disable it if
you choose to do so.
+In URLs and paths, a name in curly braces, such as `\{collectionName}` or
`\{coreName}`, stands for a value you replace with your own.
Review Comment:
Oh NICEIn fact, I wonder if we need to clue our LLM's better into
the existence of this page so we generated better docs?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
epugh commented on code in PR #5005:
URL: https://github.com/apache/solr/pull/5005#discussion_r4167788831
##
solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc:
##
@@ -140,7 +140,7 @@ If the collection is named `collection1`, the package name
is `mypackage`, and t
[source,bash]
-curl "http://localhost:8983/api/collections/collection1/config/params"; \
+curl "http://localhost:8983/api/collections/{collectionName}/config/params"; \
Review Comment:
See, here we don't have the `-X GET`... Also, if that is a fix to do in a
seperate PR, we can do that.. jsut wanted to make sure we aren't stepping on
something..
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
Re: [PR] SOLR-18495: Use {name} placeholders for names in Ref Guide URLs [solr]
epugh commented on code in PR #5005:
URL: https://github.com/apache/solr/pull/5005#discussion_r4167784139
##
solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc:
##
@@ -352,15 +352,15 @@ V1 API::
[source,bash]
-curl -X GET
"http://localhost:8983/solr/admin/cores?action=RENAME&core=currentCoreName&other=newCoreName";
+curl -X GET
"http://localhost:8983/solr/admin/cores?action=RENAME&core={currentCoreName}&other=newCoreName";
Review Comment:
Didn't we decide we would NOT have `-X GET` since that's the default in all
our curl commands? Can you verify that we didn't do this somehwere else?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
-
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
