Skip to content

Conversation

sbernauer
Copy link
Member

Hopefully fixes

[11:54:01.505] WARN (asciidoctor): skipping reference to missing attribute: hbase_home
    file: docs/modules/hbase/pages/usage-guide/overrides.adoc
    source: https://github.com/stackabletech/hbase-operator.git (branch: main | start path: docs)
[11:54:01.507] WARN (asciidoctor): skipping reference to missing attribute: hbase_home
    file: docs/modules/hbase/pages/usage-guide/overrides.adoc
    source: https://github.com/stackabletech/hbase-operator.git (branch: main | start path: docs)

@sbernauer sbernauer self-assigned this Feb 12, 2025
Copy link
Member

@razvan razvan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't fix the warning for me.

Removing the accolades fixes it.

diff --git a/docs/modules/hbase/pages/usage-guide/overrides.adoc b/docs/modules/hbase/pages/usage-guide/overrides.adoc
index b27302b..29adc83 100644
--- a/docs/modules/hbase/pages/usage-guide/overrides.adoc
+++ b/docs/modules/hbase/pages/usage-guide/overrides.adoc
@@ -104,10 +104,10 @@ Using JVM argument overrides you can configure the JVM arguments xref:concepts:o
 One thing that is different for Kafka, is that all heap-related arguments will be passed in via the env variable `HBASE_HEAPSIZE`, all the other ones via `HBASE_OPTS`, `HBASE_MASTER_OPT
S`, `HBASE_REGIONSERVER_OPTS` and `HBASE_REST_OPTS`.
 The `HBASE_HEAPSIZE` variable is documented as follows in the https://cwiki.apache.org/confluence/display/HADOOP2/Hbase+FAQ+Operations[HBase FAQs]:
 
-> Set the `HBASE_HEAPSIZE` environment variable in `${HBASE_HOME}/conf/hbase-env.sh` if your install needs to run with a larger heap.
+> Set the `HBASE_HEAPSIZE` environment variable in `$HBASE_HOME/conf/hbase-env.sh` if your install needs to run with a larger heap.
 > `HBASE_HEAPSIZE` is like `HADOOP_HEAPSIZE` in that its value is the desired heap size in MB.
 > The surrounding '-Xmx' and 'm' needed to make up the maximum heap size java option are added by the hbase start script
-> (See how `HBASE_HEAPSIZE` is used in the `${HBASE_HOME}/bin/hbase` script for clarification).
+> (See how `HBASE_HEAPSIZE` is used in the `$HBASE_HOME/bin/hbase` script for clarification).
 
 Looking at `bin/hbase`, you can actually add the `m` suffix to make the unit more clear, the script will detect this https://github.com/apache/hbase/blob/777010361abb203b8b17673d84acf4f7f1d0283a/bin/hbase#L165[here] and work correctly.
 

@sbernauer
Copy link
Member Author

sbernauer commented Feb 13, 2025

Thanks for the patch! It changes the quote a bit, but YOLO

BTW, very strange that it tries to interpret stuff in single quotes :/

@sbernauer sbernauer requested a review from razvan February 13, 2025 07:23
@sbernauer sbernauer added this pull request to the merge queue Feb 13, 2025
Merged via the queue into main with commit 32b4e55 Feb 13, 2025
17 checks passed
@sbernauer sbernauer deleted the docs/fix-rendering branch February 13, 2025 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants