Skip to content

Update iMac_in_the_lab.md #27

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

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Conversation

avanaudenhaege
Copy link
Contributor

@avanaudenhaege avanaudenhaege commented Sep 19, 2024

copy paste from gdoc

Summary by Sourcery

Add new documentation for the iMacs in the lab, detailing the number of iMacs, providing a link to an information sheet, and offering guidelines for account management and admin access.

Documentation:

  • Add documentation for the iMacs in the lab, including the number of iMacs, a link to an information sheet, and guidelines for account creation and admin access.

copy paste from gdoc
Copy link
Contributor

sourcery-ai bot commented Sep 19, 2024

Reviewer's Guide by Sourcery

This pull request adds a new file 'iMac_in_the_lab.md' to the 'doc' directory. The file provides information about the iMacs in the lab, including their number, how to find more details, best practices for account creation, and admin account information.

File-Level Changes

Change Details Files
Add new documentation file for iMacs in the lab
  • Specify the current number of iMacs in the lab
  • Provide a link to an Excel sheet with detailed information about lab computers
  • Recommend creating individual accounts for different Matlab Tool versions
  • Include admin account information and password
doc/iMac_in_the_lab.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @avanaudenhaege - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Avoid sharing admin passwords in documentation, especially if it's publicly accessible. Consider removing or securely managing this sensitive information.
  • Instead of hardcoding the date (July 2024), consider using a more dynamic approach or add a note about the need for regular updates to keep the information current.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@@ -0,0 +1,6 @@
There are currently (update: July 2024) 4 iMacs in the lab.
If you want information about a computer or iMac in the lab, please consult this [excel sheet] (https://docs.google.com/spreadsheets/d/1U5_rjj5mzXzh_8bLA_Rx3FmDdpYIUx2Y_z8SJPnKTHg/edit?gid=0#gid=0).
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (documentation): Fix markdown link formatting

Remove the space between the square brackets and parentheses to make the link functional.


It is good practice to create your own account on the computer in order not to install on the same account a different version of Matlab Tools.

All iMacs have an **admin** account, password : **CPP**.
Copy link
Contributor

Choose a reason for hiding this comment

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

question (documentation): Consider security implications of sharing admin password

Is it necessary to include the admin password in this document? If so, ensure this document has appropriately restricted access.

@fcerpe fcerpe merged commit b1a67fe into main Sep 19, 2024
1 check passed
@marcobarilari marcobarilari deleted the avanaudenhaege-update-iMac-Section branch February 27, 2025 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants