Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.hugo*
*~
resources/
public/
_build/
content/_build/
.DS_Store
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[submodule "themes/scientific-python-hugo-theme"]
path = themes/scientific-python-hugo-theme
url = https://github.com/scientific-python/scientific-python-hugo-theme
[submodule "external-content/cookie"]
path = external-content/cookie
url = https://github.com/scientific-python/cookie
16 changes: 9 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 `./content/_build/html`
html: prepare
hugo
(cd content && 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 content/_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
(cd content && myst start)

clean: ## Remove built files
clean:
rm -rf public
rm -rf content/_build public
File renamed without changes
70 changes: 0 additions & 70 deletions config.yaml

This file was deleted.

File renamed without changes.
1 change: 0 additions & 1 deletion content/community/_index.md → content/community/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions content/community/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
66 changes: 0 additions & 66 deletions content/contributors/_index.md

This file was deleted.

4 changes: 2 additions & 2 deletions content/contributors/first-contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions content/contributors/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand Down
57 changes: 57 additions & 0 deletions content/contributors/index.md
Original file line number Diff line number Diff line change
@@ -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.
:::

::::
18 changes: 0 additions & 18 deletions content/documentation/_index.md

This file was deleted.

16 changes: 16 additions & 0 deletions content/documentation/index.md
Original file line number Diff line number Diff line change
@@ -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.
:::

::::
40 changes: 14 additions & 26 deletions content/_index.md → content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}
::::

<!--
# - buttonText: Maintainer Guide
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: "Maintainers"
---

{{< admonition warning >}}
:::{warning}
This is a draft document.
{{< /admonition >}}
:::

The scientific Python ecosystem welcomes your expertise and enthusiasm!

Expand Down
Loading