[
https://issues.apache.org/jira/browse/SOLR-18494?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18121646#comment-18121646
]
Serhiy Bzhezytskyy commented on SOLR-18494:
-------------------------------------------
On main (c3e18f1) 616 listing blocks hold a curl or bin/solr command: 465 are
[source,bash], 123 are console, and 28 use text, plain, terminal, powershell,
sh or no language (enabling-ssl.adoc alone mixes terminal, powershell, bash,
console and text).
The mix is mostly in bin/solr blocks: 81 bash against 78 console, while curl
blocks are 86 % bash. doc.css has a rule for console only (.language-console
.hljs-meta \{ user-select: none; }). 77 console blocks have a $ prompt and 46
do not; 20 bash blocks have one (e.g. configsets-api.adoc:179).
One convention would be: [source,bash] with no prompt for a block of commands
only; [,console] with $ when the block also shows output; [source,text] for
output alone; powershell for the Windows variants. That is what most of the
guide does already; about 90 blocks differ.
> Standard formatting for commands in ref guide
> ---------------------------------------------
>
> Key: SOLR-18494
> URL: https://issues.apache.org/jira/browse/SOLR-18494
> Project: Solr
> Issue Type: Sub-task
> Components: documentation
> Reporter: Eric Pugh
> Priority: Minor
>
> The ref guide wraps curl commands in multiple ways...
> `[source,bash]`,`[source,text]`, even heck, `[,console]` !
>
> What is the right way of handling this, and does it make sense to use a
> single way for all our commands? curl, bin/solr etc in our Ref Guide?
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
