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.

Sign up for GitHub

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

Jump to bottom

Merge full rewrite and update of plugin tutorial #11

Merged
merged 62 commits into from
Jan 28, 2025
Merged

Merge full rewrite and update of plugin tutorial #11

merged 62 commits into from
Jan 28, 2025

Conversation

CAM-Gerlach
Copy link
Member

Pull Request

Pull Request Checklist

  • Read and followed this repo's Contributing Guidelines
  • Based your PR on the latest version of the correct branch
  • Checked your code and writing carefully
  • Described your changes and the motivation for them below

Description of Changes

Merge the full tutorial rewrite developed with @yeimiyaz after final changes and updating the plugin example repository URL.

yeimiyaz and others added 30 commits October 20, 2024 15:47
@yeimiyaz
Modify title and description of the tutorial
1f28c22
@yeimiyaz
Adjustment of learning goals.
511e8c4
@yeimiyaz
Improvement of "Spyder for developers" section
4eb358a
@yeimiyaz
Modify the explanation of the plugin and Pomodoro T.
72c7794
@yeimiyaz
Modifications on "What will we do?" section
8f0327e
@yeimiyaz
Modify "Development environment" section
9068dd7
@yeimiyaz
Modify the section "Defining the plugin structure"
a670a9c
@yeimiyaz
Remove empty spaces
a13eb75
@CAM-Gerlach
Add line breaks so first plugin tutorial part is one sentence per line
e5b4e63
@CAM-Gerlach
Fix heading formatting and spacing in plugin tutorial
88e6cbc
@CAM-Gerlach
Fix term casing to be correct and consistent
9a39df3
@CAM-Gerlach
Fix code blocks in first part of tutorial
a638af1
@CAM-Gerlach
Fix straightforward grammar and syntax errors and inconsistencies
6fb9cbe
@CAM-Gerlach
Apply basic RST and Sphinx formatting to first part of tutorial
a427bfa
@CAM-Gerlach
Add ref labels & link them where needed for easy user navigation
e638d21
@CAM-Gerlach
Further refine content and language following review and discussion
7fda8bf
@CAM-Gerlach
Fix a couple small syntax/lint issues in applied suggestions
65e744c
@CAM-Gerlach
Improve tutorial through "Defining the plugin structure" section (#4)
d006202 
Modify the first sections of the tutorial.
@yeimiyaz @CAM-Gerlach
Modify building first plugin / Widgets.
47095f0
@yeimiyaz @CAM-Gerlach
Modify building first plugin / Container
58075b9
@yeimiyaz @CAM-Gerlach
Add line breaks and fix grammar errors in the "Building our first plu…
8e50d15 
…gin" section
@yeimiyaz @CAM-Gerlach
Improve the subsection "Plugin" in the "Building our first plugin" se…
be69bbc 
…ction.
@yeimiyaz @CAM-Gerlach
Improve the "Testing our plugin" section.
bdfaccc
@CAM-Gerlach
Adjust line breaks and headings
9abe89a
@CAM-Gerlach
Modify content to fix phrasing, add RST/Sphinx & improve structure
26138ae
@CAM-Gerlach
Add reference labels and cross-references to sections
84011f6
@CAM-Gerlach
Further modify tutorial content per Carlos' feedback
8f3ecce
@CAM-Gerlach
Merge pull request #6 from yeimiyaz/plugin-workshop-building-test
57b8c00 
Improve tutorial "Building our first plugin" and "Testing our plugin" sections
@yeimiyaz @CAM-Gerlach
Include Iine breaks, fix some upper cases.
8e5708c
@yeimiyaz @CAM-Gerlach
Improve the "Enhancing our plugin" section
b58efb4
CAM-Gerlach and others added 24 commits December 6, 2024 01:33
@CAM-Gerlach
Add and update ref labels and xrefs in the sections
1bc425f
@CAM-Gerlach
Apply additional changes suggested by Carlos and Yeimi
d8d399f
@CAM-Gerlach
Merge pull request #7 from yeimiyaz/plugin-workshop-enhancingPlugin-t…
3c5cca9 
…imerControls

Improve tutorial "Enhancing our plugin" and "Timer controls" sections
@yeimiyaz @CAM-Gerlach
Include Iine breaks
c4447bf
@yeimiyaz @CAM-Gerlach
Improve "Configuration defaults" section
0433490
@yeimiyaz @CAM-Gerlach
Improve the "Configuration page" section
dc633d9
@yeimiyaz @CAM-Gerlach
Improve the "configuration changes" subsection
ef83b6f
@yeimiyaz @CAM-Gerlach
Improve the "Registering preferences" subsection
e1c731f
@yeimiyaz @CAM-Gerlach
Improvement of grammatical errors
c075880
@yeimiyaz @CAM-Gerlach
Improve the "Publishing your plugin" section
57a332f
@CAM-Gerlach
Fix line breaks and headings in tutorial sections
f161fe1
@CAM-Gerlach
Move diff links to section ends & make them drastically more concise
ba84c47
@CAM-Gerlach
Make substantive changes to tutorial sections
5eef52e
@CAM-Gerlach
Add ref labels to sections
b2b1f65
@CAM-Gerlach
Add changes requested by Carlos
158a83a
@CAM-Gerlach
Merge pull request #8 from yeimiyaz/plugin-workshop-addConfigurationP…
d60c2db 
…age-PublishingPlugin

Improve tutorial "Add configuration page" and  "Publishing plugin" sections
@yeimiyaz @CAM-Gerlach
Include line breaks
4dd4233
@yeimiyaz @CAM-Gerlach
Improve the "Final words" section
e9fa4dd
@yeimiyaz @CAM-Gerlach
Improve the "Further reading" section
aea8f7e
@CAM-Gerlach
Fix line breaks of section
d906ed6
@CAM-Gerlach
Edit content of tutorial sections
270d50b
@CAM-Gerlach
Add reference labels to tutorial section
b2b2782
@CAM-Gerlach
Merge pull request #9 from yeimiyaz/plugin-workshop-finalWords-furthe…
f093d75 
…rReading

Improve tutorial "Final words" and "Further reading" sections
@CAM-Gerlach
Replace map0logo plugin example repo with Spyder organization one
663081c
@CAM-Gerlach CAM-Gerlach added the enhancement New feature or request label Jan 28, 2025
@CAM-Gerlach CAM-Gerlach self-assigned this Jan 28, 2025
@netlify Netlify
Copy link

netlify bot commented Jan 28, 2025 •
edited
Loading

✅ Deploy Preview for spyder-api-docs-preview ready!

Name Link
🔨 Latest commit 663081c
🔍 Latest deploy log https://app.netlify.com/sites/spyder-api-docs-preview/deploys/679960b77b21010008f0e8d5
😎 Deploy Preview https://deploy-preview-11--spyder-api-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ccordoba12
ccordoba12 approved these changes Jan 28, 2025
View reviewed changes
Copy link
Member

@ccordoba12 ccordoba12 left a comment

Choose a reason for hiding this comment

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

Thanks @CAM-Gerlach!

@CAM-Gerlach CAM-Gerlach merged commit 0fc6a5d into master Jan 28, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ccordoba12 ccordoba12 ccordoba12 approved these changes

Assignees

@CAM-Gerlach CAM-Gerlach

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@CAM-Gerlach @ccordoba12 @yeimiyaz