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

DOC: Update the tutorials #266

Closed
wants to merge 2 commits into from
Closed

DOC: Update the tutorials #266

wants to merge 2 commits into from

Conversation

benoit9126
Copy link
Member

I updated the tutorials using the last version of RLF. I also add some README files

@benoit9126 benoit9126 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 4, 2024
@benoit9126 benoit9126 requested a review from alihamdan September 4, 2024 16:02
@benoit9126 benoit9126 self-assigned this Sep 4, 2024
@alihamdan alihamdan marked this pull request as draft November 17, 2024 09:54
@alihamdan
Copy link
Member

This is blocked on the current changes that break the API, converted to draft.

@alihamdan
Copy link
Member

alihamdan commented Jan 3, 2025

I updated the tutorials repository. I suggest that we remove the tutorials from this repository and link to the other repository instead when we make it public after the next release.

I know I advocated for including the tutorials here before but there are things that I didn't consider before that would affect beginners, namely:

  • Problems with git lfs on Windows as this repository uses lfs because it includes large pdf files. I only noticed these problems recently when working on another project on Windows with Louise
  • Downloading the tutorials as a zip file as an alternative for people who don't have git installed (mainly Windows users :/). This is what most users comming from https://github.com/Team-Nando/Tutorial-DERHostingCapacity-0-dss_python?tab=readme-ov-file#run-part-0 will be doing
  • Using the wrong rlf if their python picked up the local folder instead of the site-packages version

I'll send a PR to remove the tutorials from here if there are no objections to the proposal @benoit9126.

@alihamdan alihamdan removed their request for review January 3, 2025 13:16
@alihamdan alihamdan mentioned this pull request Jan 6, 2025
@alihamdan alihamdan closed this in 71daae0 Jan 6, 2025
@alihamdan alihamdan deleted the tutorials branch January 6, 2025 14:40
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants