diff --git a/.gitignore b/.gitignore index 91685eb..7ef849f 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ *~ resources/ public/ +_build/ .DS_Store diff --git a/Makefile b/Makefile index 1bfc407..a24aff8 100644 --- a/Makefile +++ b/Makefile @@ -24,17 +24,19 @@ cookie: cookie_ruby_deps cookie_web_prepare external: cookie -html: ## Build learn site (without external content) in `./public` +html: ## Build learn site in `./_build/html` html: prepare - hugo + myst build --html -html-all: ## Buildlearn site (with external content) in `./public` -html-all: html external +html-all: ## Build learn site with external content in `./public` +html-all: html + mkdir -p public && cp -r _build/html/. public/ + $(MAKE) external -serve: ## Serve site, typically on http://localhost:1313 +serve: ## Serve site, typically on http://localhost:3000 serve: prepare - @hugo --printI18nWarnings server + myst start clean: ## Remove built files clean: - rm -rf public + rm -rf _build public diff --git a/static/images/logo.svg b/assets/images/logo.svg similarity index 100% rename from static/images/logo.svg rename to assets/images/logo.svg diff --git a/content/about/_index.md b/content/about/index.md similarity index 100% rename from content/about/_index.md rename to content/about/index.md diff --git a/content/community/_index.md b/content/community/index.md similarity index 96% rename from content/community/_index.md rename to content/community/index.md index 989d72d..24bd05a 100644 --- a/content/community/_index.md +++ b/content/community/index.md @@ -1,6 +1,5 @@ --- title: "Community Guide" -shortcutDepth: 2 --- Welcome to the Community Managers Guide! Here you will find useful resources that will help you foster your community better. diff --git a/content/community/onboarding.md b/content/community/onboarding.md index 5f7559d..76a8a0e 100644 --- a/content/community/onboarding.md +++ b/content/community/onboarding.md @@ -2,9 +2,9 @@ title: "Onboarding" --- -{{< admonition warning >}} +:::{warning} This is a draft document. -{{< /admonition >}} +::: - Organizing sprints - Organising sprints are an excellent way to invite new collaborators, solve issues, gather contributions and broaden the project community. Some helpful tips for organising a sprint efficiently: diff --git a/content/contributors/_index.md b/content/contributors/_index.md deleted file mode 100644 index dc595b4..0000000 --- a/content/contributors/_index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Contributor Guide" -shortcutDepth: 2 ---- - -Welcome to the Contributor Guide! Here you will find useful resources that will help you start contributing to the Scientific Python ecosystem. - -## First steps - -{{< grid columns="1 2 2 3" >}} - -[[item]] -type = 'card' -title = 'Why Contribute' -link = 'why-contribute' -body = 'Learn some of the reasons why contributing to open source Scientific Python is impactful and can be a transformative experience for developers!' - -[[item]] -type = 'card' -title = 'Ways to contribute' -link = 'ways-to-contribute' -body = 'Learn some of the ways you can contribute to open source Scientific Python projects without having to code.' - -[[item]] -type = 'card' -title = 'Choosing a project' -link = 'choosing-a-project' -body = 'Learn how to choose a project to start contributing to the Scientific Python Ecosystem.' - -[[item]] -type = 'card' -title = 'Getting started' -link = 'getting-started' -body = 'Learn the first steps to contribute to open source Scientific Python.' - -[[item]] -type = 'card' -title = 'First contribution' -link = 'first-contribution' -body = 'Start working on your first contribution to open source Scientific Python.' - -{{< /grid >}} - -## Getting set up - -{{< grid columns="1 2 2 3" >}} - -[[item]] -type = 'card' -title = 'Ecosystem' -link = 'setup/ecosystem' -body = 'Learn how the Scientific Python ecosystem is composed and some of its main packages.' - -[[item]] -type = 'card' -title = 'Install' -link = 'setup/install' -body = '''Learn the tools' intallation process in order to start contributing to the Scientific Python ecosystem.''' - -[[item]] -type = 'card' -title = 'Next steps' -link = 'setup/next-steps' -body = 'Start exploring some of the packages from the Scientific Python ecosystem.' - -{{< /grid >}} diff --git a/content/contributors/first-contribution.md b/content/contributors/first-contribution.md index 4a2a595..249cb14 100644 --- a/content/contributors/first-contribution.md +++ b/content/contributors/first-contribution.md @@ -113,7 +113,7 @@ git push -u origin [BRANCH NAME] Enter your GitHub username and password if requested. -{{< admonition note >}} +:::{note} Entering your username and password every time you run `git push` can get tedious! Luckily GitHub lets you use an SSH key to authenticate automatically. Basically this involves creating two special files: one kept secret on your computer, and one uploaded to GitHub. If you want to set that up, see here: @@ -123,7 +123,7 @@ Basically this involves creating two special files: one kept secret on your comp You can also set up an SSH key using the `gh` command-line tool: https://cli.github.com/manual/ if you prefer. Mac and Windows users (but not Linux users!) who prefer to use `git` through a GUI can manage authentication using the [GitHub Desktop app](https://desktop.github.com/). -{{< /admonition >}} +::: ### Step 9: Open PR diff --git a/content/contributors/getting-started.md b/content/contributors/getting-started.md index bc63d17..32c5784 100644 --- a/content/contributors/getting-started.md +++ b/content/contributors/getting-started.md @@ -20,8 +20,8 @@ title: "Getting started" How do you choose which project to contribute to? There's no single best way to choose a project, but here are some questions to think about when choosing: -- _Is there a project related to your background or your research?_ E.g., astronomers might prefer to contribute to [astropy]() or [sunpy](). -- _Is there a package you're already using?_ Even well-established general-purpose packages like [numpy](), [scipy](), or [matplotlib]() are still growing and changing, and need contributors. +- _Is there a project related to your background or your research?_ E.g., astronomers might prefer to contribute to [astropy](https://www.astropy.org/) or [sunpy](https://sunpy.org/). +- _Is there a package you're already using?_ Even well-established general-purpose packages like [numpy](https://numpy.org/), [scipy](https://scipy.org/), or [matplotlib](https://matplotlib.org/) are still growing and changing, and need contributors. - _Is the project actively developed?_ Take a look at the project's repository to see how recent the last update was, and how many people seem to be involved. - _Is the community healthy?_ Project maintainers will be reviewing your work and mentoring you through the contribution process, so look to see if the interactions on the project's pull request pages are polite and welcoming. @@ -37,7 +37,7 @@ Other tools we use daily include: - git and GitHub - the command-line terminal, and -- a plain-text editor or [integrated development environment]() ("IDE"). +- a plain-text editor or [integrated development environment](https://en.wikipedia.org/wiki/Integrated_development_environment) ("IDE"). In this video series, the basics of using these tools are covered along the way. To learn more about them, take at the links below: diff --git a/content/contributors/index.md b/content/contributors/index.md new file mode 100644 index 0000000..a5a5923 --- /dev/null +++ b/content/contributors/index.md @@ -0,0 +1,57 @@ +--- +title: "Contributor Guide" +--- + +Welcome to the Contributor Guide! Here you will find useful resources that will help you start contributing to the Scientific Python ecosystem. + +## First steps + +::::{grid} 1 2 2 3 + +:::{card} Why Contribute +:link: why-contribute +Learn some of the reasons why contributing to open source Scientific Python is impactful and can be a transformative experience for developers! +::: + +:::{card} Ways to contribute +:link: ways-to-contribute +Learn some of the ways you can contribute to open source Scientific Python projects without having to code. +::: + +:::{card} Choosing a project +:link: choosing-a-project +Learn how to choose a project to start contributing to the Scientific Python Ecosystem. +::: + +:::{card} Getting started +:link: getting-started +Learn the first steps to contribute to open source Scientific Python. +::: + +:::{card} First contribution +:link: first-contribution +Start working on your first contribution to open source Scientific Python. +::: + +:::: + +## Getting set up + +::::{grid} 1 2 2 3 + +:::{card} Ecosystem +:link: setup/ecosystem +Learn how the Scientific Python ecosystem is composed and some of its main packages. +::: + +:::{card} Install +:link: setup/install +Learn the tools' intallation process in order to start contributing to the Scientific Python ecosystem. +::: + +:::{card} Next steps +:link: setup/next-steps +Start exploring some of the packages from the Scientific Python ecosystem. +::: + +:::: diff --git a/content/documentation/_index.md b/content/documentation/_index.md deleted file mode 100644 index e461325..0000000 --- a/content/documentation/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Documentation Guide" -shortcutDepth: 2 ---- - -Welcome to the Documentation Guide! Here you will find resources that describe documenting practices relevant to the ecosystem. - -## Documentation Authoring - -{{< grid columns="1 2 2 3" >}} - -[[item]] -type = 'card' -title = 'Accessible Documentation' -link = 'accessible-documentation' -body = 'Learn about how to structure and write project documentation that considers disabled and abled readers.' - -{{< /grid >}} diff --git a/content/documentation/index.md b/content/documentation/index.md new file mode 100644 index 0000000..4a8fba7 --- /dev/null +++ b/content/documentation/index.md @@ -0,0 +1,16 @@ +--- +title: "Documentation Guide" +--- + +Welcome to the Documentation Guide! Here you will find resources that describe documenting practices relevant to the ecosystem. + +## Documentation Authoring + +::::{grid} 1 2 2 3 + +:::{card} Accessible Documentation +:link: accessible-documentation +Learn about how to structure and write project documentation that considers disabled and abled readers. +::: + +:::: diff --git a/content/_index.md b/content/index.md similarity index 60% rename from content/_index.md rename to content/index.md index bcecd6c..b9c9ee3 100644 --- a/content/_index.md +++ b/content/index.md @@ -2,41 +2,29 @@ title: --- -{{< grid columns="1 2 2 2" >}} +::::{grid} 1 2 2 2 -[[item]] -type = 'card' -title = 'Contributor Guide' -link = '/contributors/' -body = ''' +:::{card} Contributor Guide +:link: /contributors/ Learn how to join the Scientific Python community! -''' +::: -[[item]] -type = 'card' -title = 'Development Guide' -link = '/development/' -body = ''' +:::{card} Development Guide +:link: /development/ Learn recommended tools and approaches for developing Scientific Python libraries. -''' +::: -[[item]] -type = 'card' -title = 'Lectures Notes' -link = 'https://lectures.scientific-python.org' -body = ''' +:::{card} Lectures Notes +:link: https://lectures.scientific-python.org Numerical computing lectures that teach key packages in the scientific Python ecosystem, such as NumPy, SciPy, Matplotlib, scikit-learn, and scikit-image. -''' +::: -[[item]] -type = 'card' -title = 'Documentation Guide' -link = '/documentation/' -body = ''' +:::{card} Documentation Guide +:link: /documentation/ Learn recommended approaches for project documentation. -''' +::: -{{< /grid >}} +::::