You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-2Lines changed: 33 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,7 @@ The rendered JuliaAstro site is published online using GitHub Pages at <https://
20
20
```julia
21
21
JuliaAstro.github.io
22
22
├── docs/
23
+
│ ├── case_studies/
23
24
│ ├── clones/
24
25
│ ├── make.jl
25
26
│ └── src/
@@ -39,7 +40,7 @@ The rendered JuliaAstro site is published online using GitHub Pages at <https://
39
40
40
41
## Contributing
41
42
42
-
Below we walk through two main ways to contribute to the JuliaAstro site:
43
+
Below we walk through three main ways to contribute to the JuliaAstro site:
43
44
44
45
### 1. Editing existing markdown content
45
46
@@ -67,6 +68,36 @@ Our Ecosystem page and Comparison page are integrated with the rest of the site,
67
68
68
69
If appropriate, we appreciate a quick entry for your package in the `astropy` field that relates it to a similar package in the [Astropy ecosystem](https://www.astropy.org/). This helps new users who may be more familiar with Python get more easily oriented in the Julia ecosystem. See our [Comparison page](https://juliaastro.org/home/comparison/) for examples. If you feel that there is not a good match for your package, you can just leave the `astropy` field blank (i.e., as an empty array `[]`) and it will not appear in this page.
69
70
71
+
### 3. Adding a new entry to our [Case studies page](https://juliaastro.org/home/case_studies/)
72
+
73
+
This is a great way to showcase how packages in the JuliaAstro and wider aero/astro ecosystem are used in real world use cases. Each case study is organized in the following way within the `docs/case_studies` directory:
74
+
75
+
```julia
76
+
JuliaAstro.github.io/docs/case_studies/
77
+
├── config.json
78
+
├── exoplanets
79
+
│ ├── config.json
80
+
│ ├── <author username>-<package name>.md
81
+
│ └── sefffal-octofitter.md
82
+
├── index.md
83
+
└── ...
84
+
```
85
+
86
+
Above is an example entry in the `exoplanets` section of the case studies page, which follows the same structure recommended in the [DemoCards.jl documentation](https://democards.juliadocs.org/stable/quickstart/). To summarize:
87
+
88
+
*`index.md` is the main case-study page that all case study cards are displayed in
89
+
* The top-level `config.json` sets the card theme and order that each case study category (e.g., solar system, exoplanets, etc.) appears.
90
+
* The second-level `config.json` sets the order that each case study within a given category will appear in
91
+
*`<author username>-<package name>.md` is the main entry point to adding a new case study and follows the same naming convention used in the rest of this site. You can follow other case study markdown files in this directory (e.g., `sefffal-octofitter.md`) as a template.
92
+
93
+
94
+
All in all, to add a new case study:
95
+
96
+
1. Navigate to the appropriate case study category, e.g., `exoplanets`
97
+
1. Copy one of the existing case study markdown files, e.g., `sefffal-octofitter.md` into your own case study file following the same naming convention, i.e., `<author username>-<package>`
98
+
1. Update the content in the new file with your case study text.
99
+
1. Add an entry to `JuliaAstro.github.io/docs/case_studies/<case study category>/config.json` with your new case study filename. Note that trailing commas are not supported in the JSON spec.
100
+
70
101
## Testing locally / developer docs
71
102
72
103
Add [LiveServer.jl](https://github.com/JuliaDocs/LiveServer.jl) to your global env and then run the following in the `JuliaAstro.github.io/` folder:
@@ -76,7 +107,7 @@ Add [LiveServer.jl](https://github.com/JuliaDocs/LiveServer.jl) to your global e
The `include_dirs` arg allows our internal Revise worklow to pick up changes in `src/JuliaAstro.jl` automatically, and the `skip_files` arg keeps Documenter.jl from falling into an infinite loop as `docs/make.jl` watches for changes to our markdown files.
0 commit comments