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

Add verbose logs mention to CONTRIBUTING.md #6703

Merged
merged 2 commits into from
May 16, 2023

Conversation

Akirathan
Copy link
Member

@Akirathan Akirathan commented May 15, 2023

Pull Request Description

Important Notes

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • All code has been tested:
    • Unit tests have been written where possible.
    • If GUI codebase was changed, the GUI was tested when built using ./run ide build.

@Akirathan Akirathan requested a review from 4e6 May 15, 2023 16:01
@Akirathan Akirathan self-assigned this May 15, 2023
@Akirathan Akirathan added the CI: No changelog needed Do not require a changelog entry for this PR. label May 15, 2023
Comment on lines 123 to 125
The logs are kept in a central location - on Linux, they are in
`$XDG_DATA_HOME/enso/log` ( usually `~/.local/share/enso/log`), and on Windows
they are in `%APPDATA%\enso\log`. The log level name consists of the timestamp
Copy link
Contributor

@4e6 4e6 May 15, 2023

Choose a reason for hiding this comment

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

Suggested change
The logs are kept in a central location - on Linux, they are in
`$XDG_DATA_HOME/enso/log` ( usually `~/.local/share/enso/log`), and on Windows
they are in `%APPDATA%\enso\log`. The log level name consists of the timestamp
The logs are kept in a central location `$ENSO_DATA_DIRECTORY/log` - on Linux,
they are in `$XDG_DATA_HOME/enso/log` (usually `~/.local/share/enso/log`), and
on Windows they are in `%APPDATA%\enso\log`, see
[distribution.md](distribution/distribution.md) for details. The log level name
consists of the timestamp

Copy link
Contributor

Choose a reason for hiding this comment

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

Technically the location is described as ENSO_DATA_DIRECTORY/log https://github.com/enso-org/enso/blob/develop/docs/distribution/distribution.md

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I'm not sure if the suggestion above is properly formatted

Copy link
Member Author

Choose a reason for hiding this comment

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

I have run ./run fmt, so it should be OK now.

@Akirathan Akirathan added the CI: Ready to merge This PR is eligible for automatic merge label May 16, 2023
@mergify mergify bot merged commit f38033b into develop May 16, 2023
@mergify mergify bot deleted the wip/akirathan/update-contributing-docs branch May 16, 2023 11:14
Procrat added a commit that referenced this pull request May 16, 2023
…z-6260

* develop:
  Add verbose logs mention to CONTRIBUTING.md (#6703)
  Hide "shared with" column on local backend (#6684)
  Fix top bar styles (#6695)
  Fix opening cloud projects (#6683)
  Show spinner when opening/creating a project (#6321)
  Fix logic for enabling dashboard (#6696)
  Create unique atom getter suggestions (#6694)
  Ensure slow shutdown of LS always kicks off hooks (#6665)
  Fix `--startup.project` to bypass opening dashboard (#6671)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI: No changelog needed Do not require a changelog entry for this PR. CI: Ready to merge This PR is eligible for automatic merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants