akka-guide
akka-guide copied to clipboard
akka
Build and inject language conveying the deprecation of the Lightbend Console
Create language that can be inserted at the top of each page of the console documentation regarding its deprecation
Marked as blocked because the lightbend/lightbend-console-docs repo is archived. Suggest that we un-archive to add this notice and then archive again.
I think this text is appropriate for the @@include to top the pages.
Please be aware that Lightbend has deprecated the Lightbend Console. Support for the console will continue through August 2022. Going forward, telemetry data will be available via downloadable Grafana graphs. This Lightbend Console documentation will continue to be available, but it is now archived and will not be updated as of August 20, 2021.
I think this text is appropriate for the @@include to top the pages.
Please be aware that Lightbend has deprecated the Lightbend Console. Support for the console will continue through August 2022. Going forward, telemetry data will be available via downloadable Grafana graphs. This Lightbend Console documentation will continue to be available, but it is now archived and will not be updated as of August 20, 2021.
This looks good @thothmoses. Just a couple of questions:
@jtownley, for the second sentence do we need to make clear that it is only for existing customers that support for the Console will continue? Something like for "Support for existing customers using the Console as of August 2021 will continue through August 2022"? or is that not necessary?
@thothmoses could you please check on the correct way to refer to telemetry? I thought the official name was Lightbend Telemetry or Akka Platform Telemetry? I would also capitalize Console in the second sentence.
We should make it clear that this support is for existing customers. Lightbend Telemetry is still the official name (thought there is some confusion on that)
Cool,
I think this text is appropriate for the @@include to top the pages. @rstento Please be aware that Lightbend has deprecated the Lightbend Console. For existing customers, support for the console will continue through August 2022. Going forward, Lightbend Telemetry data will be available via downloadable Grafana graphs. This Lightbend Console documentation will continue to be available, but it is now archived and will not be updated as of August 20, 2021.
Cool,
I think this text is appropriate for the @@include to top the pages. @rstento Please be aware that Lightbend has deprecated the Lightbend Console. For existing customers, support for the console will continue through August 2022. Going forward, Lightbend Telemetry data will be available via downloadable Grafana graphs. This Lightbend Console documentation will continue to be available, but it is now archived and will not be updated as of August 20, 2021.
Not to be pedantic, or maybe to be pedantic. Second sentence s/be something like: For existing customers using the Console, support will continue through August 2022. Reason: we might have existing customers not using Console at the moment and we don't want them to start :-).
Oh, and can the sentence about Grafana graphs have a link to the doc that describes them?
@rstento Please be aware that Lightbend has deprecated the Lightbend Console. Support for the console will continue through August 2022. Going forward, telemetry data will be available via downloadable Grafana graphs. Details about installing the Grafana graphs can be found In the https://developer.lightbend.com/docs/akka-platform-guide/deployment/aws-install-quickstart.html[Amazon Elastic Kubernetes Service (EKS) Quick Start {new-tab}, window="new” ], and the https://developer.lightbend.com/docs/akka-platform-guide/deployment/gcp-install-quickstart.html[Google Kubernetes Engine (GKE) Quick Start {new-tab}, window="new” ]. This Lightbend Console documentation will continue to be available but is now archived and will not be updated as of August 20, 2021.
For the other documentation - I think we can swap the last sentence so it reads:
Please be aware that Lightbend has deprecated the Lightbend Console. Support for the console will continue through August 2022. Going forward, telemetry data will be available via downloadable Grafana graphs. Details about installing the Grafana graphs can be found In the https://developer.lightbend.com/docs/akka-platform-guide/deployment/aws-install-quickstart.html[Amazon Elastic Kubernetes Service (EKS) Quick Start {new-tab}, window="new” ], and the https://developer.lightbend.com/docs/akka-platform-guide/deployment/gcp-install-quickstart.html[Google Kubernetes Engine (GKE) Quick Start {new-tab}, window="new” ]. The following information is for archive purposes only.
@thothmoses, thanks for the links, but the second sentence about existing customers has gone back to the old one and telemetry s/be Lightbend Telemetry.
Urk! That is what happens when I work on the same thing in two places.
@rstento Please be aware that Lightbend has deprecated the Lightbend Console. For existing customers who are currently using the Console, support will continue through August 2022. Going forward, Lightbend Telemetry data will be available via downloadable Grafana graphs. Details about installing the Grafana graphs can be found In the https://developer.lightbend.com/docs/akka-platform-guide/deployment/aws-install-quickstart.html[Amazon Elastic Kubernetes Service (EKS) Quick Start {new-tab}, window="new” ], and the https://developer.lightbend.com/docs/akka-platform-guide/deployment/gcp-install-quickstart.html[Google Kubernetes Engine (GKE) Quick Start {new-tab}, window="new” ]. This Lightbend Console documentation will continue to be available but is now archived and will not be updated as of August 20, 2021.
For the other documentation - I think we can swap the last sentence so it reads:
Please be aware that Lightbend has deprecated the Lightbend Console. For existing customers who are currently using the Console, support will continue through August 2022. Going forward, Lightbend Telemetry data will be available via downloadable Grafana graphs. Details about installing the Grafana graphs can be found In the https://developer.lightbend.com/docs/akka-platform-guide/deployment/aws-install-quickstart.html[Amazon Elastic Kubernetes Service (EKS) Quick Start {new-tab}, window="new” ], and the https://developer.lightbend.com/docs/akka-platform-guide/deployment/gcp-install-quickstart.html[Google Kubernetes Engine (GKE) Quick Start {new-tab}, window="new” ]. The following information is for archive purposes only.
@jtownley @thothmoses, I can't find anywhere in the Akka Platform Guide where it explains what the Grafana and Prometheus helm charts are and why you would want to use them. Am I missing something? The Telemetry section says that it "can report metrics to Prometheus" but again, no motivation or conceptual overview.
@rstento This does have to be linked and built out - most of the information is in the Lightbend Telemetry documentation.
https://developer.lightbend.com/docs/telemetry/current/visualizations/grafana.html#running-grafana
@rstento This does have to be linked and built out - most of the information is in the Lightbend Telemetry documentation.
https://developer.lightbend.com/docs/telemetry/current/visualizations/grafana.html#running-grafana
But that still doesn't contain any conceptual overview. Well, I partially take that back, there is some if you read the whole page. But, nothing to give someone who isn't already well-versed on these technologies an understanding of how they relate to use of Telemetry. It wouldn't take much than a few sentences and a diagram would help. I surmise that Grafana is the visualization part and you can store the metrics in Prometheus, etc?
@rstento I concur - hence the 'built out' bit. We should also have descriptions of the various graphs/charts. We may be able to leverage some of the text from the Console doc to provide enrichment.