You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "ZhangNing10 (via GitHub)" <gi...@apache.org> on 2023/11/08 08:58:04 UTC

[PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

ZhangNing10 opened a new pull request, #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675

   # Summary
   
   adjust helmsetup to add grafana pw notes
   
   ### Does this close any open issues?
   Closes xx
   
   ### Screenshots
   Include any relevant screenshots here.
   
   ### Other Information
   Any other information that is important to this 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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

Posted by "hezyin (via GitHub)" <gi...@apache.org>.
hezyin commented on code in PR #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675#discussion_r1388398696


##########
docs/GettingStarted/HelmSetup.md:
##########
@@ -26,17 +26,19 @@ To install the chart with release name `devlake`,follow these steps:
 
 2.  Copy the generated string, set the value of the ENCRYPTION_SECRET environment variable by running the following command:
 
-        ```
-        export ENCRYPTION_SECRET="copied string"
-        ```
+    ```
+    export ENCRYPTION_SECRET="copied string"
+    ```
 
-        This command will set the `ENCRYPTION_SECRET` environment variable to the value of the copied string.
+    This command will set the `ENCRYPTION_SECRET` environment variable to the value of the copied string.
 
     **Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**
 
-3.  By default, the timezone is UTC. You can set your timezone via --set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"
+3.  By default, the timezone is UTC. You can set your timezone via `--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"`, refering to [FAQ](#faq).

Review Comment:
   "refering to [FAQ](#faq)" lacks clarity, I think what you want to say here is more like "for more information, please refer to [FAQ](#faq)". GPT-4's suggestion for the entire sentence:
   
   By default, the system uses UTC as the timezone. To customize the timezone settings, apply the `--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"` command. For further guidance, please consult the [FAQ section](#faq).



-- 
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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

Posted by "hezyin (via GitHub)" <gi...@apache.org>.
hezyin commented on code in PR #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675#discussion_r1386861232


##########
docs/GettingStarted/HelmSetup.md:
##########
@@ -34,9 +34,11 @@ To install the chart with release name `devlake`,follow these steps:
 
     **Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**
 
-3.  By default, the timezone is UTC. You can set your timezone via --set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"
+3.  By default, the timezone is UTC. You can set your timezone via ```--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"```.
 
-4.  Install the chart by running the following commands:
+4.  By default, a random password is generated and stored in a Kubernetes Secret for the Grafana admin user. Alternatively, you can explicitly set the password via ```--set grafana.adminPassword=<your password>```.

Review Comment:
   @ZhangNing10 Same with the ` vs ```. Also, it's better to provide a pointer/link to the example in the FAQ section.



##########
docs/GettingStarted/HelmSetup.md:
##########
@@ -34,9 +34,11 @@ To install the chart with release name `devlake`,follow these steps:
 
     **Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**
 
-3.  By default, the timezone is UTC. You can set your timezone via --set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"
+3.  By default, the timezone is UTC. You can set your timezone via ```--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"```.

Review Comment:
   @ZhangNing10 I presume what you want here is inline code, so maybe consider using ` instead of ```? Also, the style of the code block above doesn't look right, please see screenshot below:
   
   <img width="2309" alt="Screen Shot 2023-11-08 at 7 56 30 AM" src="https://github.com/apache/incubator-devlake-website/assets/2908155/083bda70-f874-44ea-a356-117352827508">
   



-- 
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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

Posted by "ZhangNing10 (via GitHub)" <gi...@apache.org>.
ZhangNing10 commented on code in PR #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675#discussion_r1387704917


##########
docs/GettingStarted/HelmSetup.md:
##########
@@ -34,9 +34,11 @@ To install the chart with release name `devlake`,follow these steps:
 
     **Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**
 
-3.  By default, the timezone is UTC. You can set your timezone via --set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"
+3.  By default, the timezone is UTC. You can set your timezone via ```--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"```.
 
-4.  Install the chart by running the following commands:
+4.  By default, a random password is generated and stored in a Kubernetes Secret for the Grafana admin user. Alternatively, you can explicitly set the password via ```--set grafana.adminPassword=<your password>```.

Review Comment:
   adjusted
   



-- 
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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

Posted by "hezyin (via GitHub)" <gi...@apache.org>.
hezyin merged PR #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675


-- 
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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Adjust helmsetup about grafana pw part [incubator-devlake-website]

Posted by "ZhangNing10 (via GitHub)" <gi...@apache.org>.
ZhangNing10 commented on code in PR #675:
URL: https://github.com/apache/incubator-devlake-website/pull/675#discussion_r1389065422


##########
docs/GettingStarted/HelmSetup.md:
##########
@@ -26,17 +26,19 @@ To install the chart with release name `devlake`,follow these steps:
 
 2.  Copy the generated string, set the value of the ENCRYPTION_SECRET environment variable by running the following command:
 
-        ```
-        export ENCRYPTION_SECRET="copied string"
-        ```
+    ```
+    export ENCRYPTION_SECRET="copied string"
+    ```
 
-        This command will set the `ENCRYPTION_SECRET` environment variable to the value of the copied string.
+    This command will set the `ENCRYPTION_SECRET` environment variable to the value of the copied string.
 
     **Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**
 
-3.  By default, the timezone is UTC. You can set your timezone via --set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"
+3.  By default, the timezone is UTC. You can set your timezone via `--set commonEnvs.TZ="your timezone",grafana.env.TZ="your timezone"`, refering to [FAQ](#faq).

Review Comment:
   adjusted



-- 
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: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org