Skip to content

Commit 7c6925f

Browse files
steppisteppi
authored
Write first draft of scientific python translations website (#1)
1 parent 233b6de commit 7c6925f

24 files changed

Lines changed: 5337 additions & 0 deletions

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "themes/scientific-python-hugo-theme"]
2+
path = themes/scientific-python-hugo-theme
3+
url = https://github.com/scientific-python/scientific-python-hugo-theme

‎Makefile‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.PHONY: help themes html serve clean
2+
.DEFAULT_GOAL := help
3+
4+
help:
5+
@grep ": ##" Makefile | grep -v grep | tr -d '#'
6+
7+
themes/scientific-python-hugo-theme:
8+
@if [ ! -d "$<" ]; then \
9+
echo "*** ERROR: missing theme" ; \
10+
echo ; \
11+
echo "It looks as though you are missing the themes directory."; \
12+
echo "You need to add the scientific-python-hugo-theme as a submodule."; \
13+
echo ; \
14+
echo "Please see https://theme.scientific-python.org/getstarted/"; \
15+
echo ; \
16+
exit 1; \
17+
fi
18+
19+
content/shortcodes.md:
20+
cp content/shortcodes.md.stub content/shortcodes.md
21+
22+
themes: themes/scientific-python-hugo-theme
23+
24+
html: ## Build site in `./public`
25+
html: themes content/shortcodes.md
26+
hugo
27+
28+
serve: ## Serve site, typically on http://localhost:1313
29+
serve: themes content/shortcodes.md
30+
@hugo --printI18nWarnings server
31+
32+
clean: ## Remove built files
33+
clean:
34+
rm -rf public

‎assets/css/custom.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.navbar-logo-text {
2+
font-family: "Lato";
3+
}

‎config.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
baseURL: "https://scientific-python-translations.github.io/"
2+
languageCode: "en-us"
3+
title: "Scientific Python Translations"
4+
theme: scientific-python-hugo-theme
5+
relativeURLs: true
6+
disableKinds: ["taxonomy"]
7+
8+
markup:
9+
highlight:
10+
noClasses: false
11+
goldmark:
12+
renderer:
13+
unsafe: true
14+
renderHooks:
15+
link:
16+
enableDefault: true
17+
18+
params:
19+
author:
20+
name: "Scientific Python Translations team"
21+
description: "Documentation & FAQ for Scientific Python Translations project."
22+
images:
23+
- /images/logo.svg
24+
navbarlogo:
25+
image: logo.svg
26+
text: Scientific Python Translations
27+
link: /
28+
hero:
29+
title: Scientific Python Translations
30+
image: logo.svg
31+
navbar:
32+
- title: FAQ
33+
url: /faq/
34+
- title: News
35+
url: /news/
36+
- title: About
37+
url: /about/
38+
# - title: Contribute
39+
# url: /contribute/
40+
footer:
41+
logo: logo.svg
42+
socialmediatitle: ""
43+
socialmedia:
44+
- link: https://github.com/scientific-python-translations/
45+
icon: github
46+
47+
quicklinks:
48+
column1:
49+
title: ""
50+
links:
51+
- text: FAQ
52+
link: /faq/
53+
- text: News
54+
link: /news/
55+
- text: About
56+
link: /about/
57+
# - text: Contribute
58+
# link: /contribute/
59+
column2:
60+
links:
61+
column3:
62+
links:

‎content/_index.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title:
3+
---
4+
5+
{{< grid columns="1 3 3 3" >}}
6+
7+
[[item]]
8+
type = 'card'
9+
title = 'Mission'
10+
body = '''
11+
To develop and publish translations of the websites for the
12+
[Scientific Python Core Projects](https://scientific-python.org/specs/core-projects/).
13+
'''
14+
15+
[[item]]
16+
type = 'card'
17+
title = 'Funding'
18+
body = '''
19+
Supported by the CZI
20+
[Scientific Python Community & Communications Infrastructure](https://scientific-python.org/doc/scientific-python-community-and-communications-infrastructure-2022.pdf)
21+
grant.
22+
'''
23+
24+
[[item]]
25+
type = 'card'
26+
title = 'See'
27+
body = '''
28+
Translations into Brazlian and Portuguese already published for https://numpy.org/!
29+
'''
30+
31+
{{< /grid >}}

‎content/_index.md~‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title:
3+
---
4+
5+
{{< grid columns="1 3 3 3" >}}
6+
7+
[[item]]
8+
type = 'card'
9+
title = 'Documented'
10+
body = '''
11+
The theme is documented at https://theme.scientific-python.org.
12+
'''
13+
14+
[[item]]
15+
type = 'card'
16+
title = 'Reusable'
17+
body = '''
18+
The theme is being used by
19+
[scientific-python.org](https://github.com/scientific-python/scientific-python.org),
20+
[numpy.org](https://github.com/numpy/numpy.org), and
21+
[scipy.org](https://github.com/scipy/scipy.org).
22+
'''
23+
24+
[[item]]
25+
type = 'card'
26+
title = 'Community Maintained'
27+
body = '''
28+
The theme is maintained by the [Theme Team](/about/).
29+
'''
30+
31+
{{< /grid >}}

‎content/about.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "About"
3+
draft: false
4+
---
5+
6+
Funded by the [Scientific Python Community and Communications Infrastructure grant](https://scientific-python.org/doc/scientific-python-community-and-communications-infrastructure-2022.pdf) from the [Chan Zuckerberg Initiative](https://chanzuckerberg.com/) (CZI), [Scientific Python](https://scientific-python.org/) and [Quansight Labs](https://labs.quansight.org/) are able to offer assistance to the maintainer teams of the [Scientific Python Core Projects](https://scientific-python.org/specs/core-projects/) to develop and publish translations of their core project websites. The goal is to allow as much of the necessary work as possible to be offloaded onto a small team of Quansight Labs staff working across the different projects, freeing busy maintainers from the burden of setting up translation infrastructure and recruiting and coordinating with translators, and helping to integrate these translations into the project websites. See the [FAQ](/faq) for more information.

‎content/contribute/_index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: "Contribute"
3+
draft: true
4+
---
5+
6+
If you'd like to help out with the effort to translate the web pages of the Scientific Python core projects, feel free to email y at y@example.com with *scientific python translations* in the subject line or make a post in the **#translations** channel on the [Scientific Python Discord Server](https://discord.com/invite/vur45CbwMz). Languages with a large population of speakers with no to low English proficiency will be priortized, but any language with enthusiastic translators who are committed to keeping translations up to date may be considered.
7+
8+
Potential translators who pass a vetting process will be given invitations to the Scientific Python Crowdin organization and on-boarded into the translation workflow.
9+
10+
There are several ways contributors can help:
11+
12+
* Make translations of web site content.
13+
* Proofread existing translations.
14+
* Make glossaries of technical terms.

‎content/data.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This is the content of data.txt.

‎content/example.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
def foo(x):
2+
return x**2

0 commit comments

Comments
 (0)