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 "Getting Started" box to front page of lesson #26

Open
eldobbins opened this issue May 9, 2020 · 2 comments
Open

Add "Getting Started" box to front page of lesson #26

eldobbins opened this issue May 9, 2020 · 2 comments

Comments

@eldobbins
Copy link

I am working my way through the lessons in preparation for teaching it in the fall. I hit a snag right off when I moved to episode 1 from the entry page without doing the set-up first. The information for setting up the files and Conda is described (very well) in the Set-up tab. However, it was easy to miss.

The front page of the Python for Atmosphere and Ocean Scientists has blue boxes marked Prerequisites and Citation. I would add another blue box called "Getting Started", modeled on the entry page of the Ecology lesson. To emphasize it, I would move the "raster vs vector data" highlight and the citation to below the Schedule.

This is an easy change. However, this is a new lesson and I'm submitting this PR in partial fulfillment of the Carpentries instructor training requirements (so I don't know quite what I'm doing). In addition, the lesson's CONTRIBUTING.md is unclear because it includes defaults like "https://github.com/swcarpentry/FIXME". So I'd like some guidance from the lesson maintainers about how they would like me to make these changes.

BTW. As I work my way through the lessons, I hope to submit many issues and PRs as I go along.

@DamienIrving
Copy link
Collaborator

@eldobbins Thanks for choosing to focus on improving the PyAOS lessons for your instructor training requirements!

Thanks also for identifying the FIXME's in the contributing file - when I used the Carpentries template for the lessons page I must have overlooked the fact that I needed to update those. (I've just created #27 related to the need to update CONTRIBUTING.md.)

With respect to your proposed changes to the landing page to better highlight the setup information (which I think is a good idea), you can submit a PR by editing the associated index.md markdown file. You'll pick up the formatting from the other prerequisite boxes in that file.

If you have other suggested improvements as you work through the lessons, the markdown files for each lesson are located in the _episodes directory. You can either edit those files directly and submit a PR, or submit an issue describing the kind of change you'd like to see if it's more than just a simple edit to a markdown file.

Feel free to reach out if you need more assistance along the way.

@eldobbins
Copy link
Author

eldobbins commented May 12, 2020

From the Curriculum Development looks like the schedule is generated automatically. That seems to mean I cannot move anything below the schedule, as I had planned.

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

No branches or pull requests

2 participants