Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update README.md #4

Merged
merged 4 commits into from
May 10, 2024
Merged

Docs: Update README.md #4

merged 4 commits into from
May 10, 2024

Conversation

DeepanshKhurana
Copy link
Member

@DeepanshKhurana DeepanshKhurana commented May 10, 2024

Changes

  • Adds a new README.md with short credit to Elkem + overall story of how the app was made
  • Also adds a link to the Appsilon + Elkem case study

@DeepanshKhurana DeepanshKhurana added the documentation Improvements or additions to documentation label May 10, 2024
@DeepanshKhurana DeepanshKhurana self-assigned this May 10, 2024

The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable.
- The LogAnalyzer app uses the Posit Connect API to fetch logs for application run jobs, semantically colouring them so they are easier to read.
- The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable. The idea is that the key should come from either an admin account or someone with privileges to view all apps. Apps that are not available to a user will not have their logs available to them.
Copy link
Member

Choose a reason for hiding this comment

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

What about the CONNECT_SERVER? It is required (at least for the local usage - I think it is set by default in Connect deployment (not 100% sure about this)).

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right! Thanks for the catch. It's set by default on the server but locally, we have to set it up. I can add a line for it.

Copy link
Member

@jakubnowicki jakubnowicki left a comment

Choose a reason for hiding this comment

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

LGTM

@DeepanshKhurana DeepanshKhurana merged commit 49bad88 into main May 10, 2024
1 check passed
@DeepanshKhurana DeepanshKhurana deleted the docs/update-readme branch May 10, 2024 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants