Skip to content

Commit

Permalink
Merge pull request #404 from ChunYen-Chen/bugfix_wiki_figure
Browse files Browse the repository at this point in the history
[Bugfix] wiki figure
  • Loading branch information
hyschive authored Jan 7, 2025
2 parents 289cd8d + ed2238b commit 692d08a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
22 changes: 11 additions & 11 deletions doc/wiki/Contribute-related/Contribute:-Update-Wiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ sequenceDiagram
1. **Create the first page**
* Click the Wiki page and create the first page.

[[images/CreateWiki.png]]
[[/images/CreateWiki.png]]

1. **Create a token for the action**
* Go to `Settings` of your account > `Developer settings` > `Personal access tokens` > `Generate new token (classic)`.
Expand All @@ -75,32 +75,32 @@ sequenceDiagram
* You might want to set the `Expiration` to `No expiration`.
* Click the green `Generate token` at the bottom.

[[images/CreateToken.png]]
[[/images/CreateToken.png]]

* Remember to save the token since it will only be shown once!

1. **Create the repository secret token and email**
* Go to `Settings` of your forked gamer repository > `Security` > `Secrets and variables` > `Actions` > `Repository secrets`.

[[images/CreateSecret.png]]
[[/images/CreateSecret.png]]

* Click `New repository secret`, and then you will see the following. Please replace `<your_personal_access_token>` with the token generated in the previous step under `Secret` and make sure the `Name` of the secret is `TOKEN_FOR_WIKI`. Click `Add secret`.

[[images/SetToken.png]]
[[/images/SetToken.png]]

* Click `New repository secret`. Please replace `<your_email_address>` with your account's email address under `Secret` and make sure the `Name` of the secret is `MY_EMAIL`. Click `Add secret`.
- NOTE: Your email address will remain private since it only exists in your repository. This step is only for recording your contribution by the action.

[[images/SetMail.png]]
[[/images/SetMail.png]]

1. **Enable actions (workflows)**
* Click `Actions` > click the green button.
![image](https://github.com/ChunYen-Chen/CheckNode/assets/70311975/9e58d4a8-3248-4ceb-81ff-276a6943149d)
[[/images/EnableWorkflows.png]]

1. **Initialize Wiki**
* Click `Actions` > `Copy doc to wiki` > `Run workflow` > Choose `Branch: main` > Click `Run workflow`. Once the workflow is complete, the Wiki will be updated to match `gamer/doc/wiki` on the `main` branch.

[[images/InitializeWiki.png]]
[[/images/InitializeWiki.png]]

## Edit Wiki
We provide three methods for editing the Wiki pages: through `gollum` (recommended), directly on the GitHub website, or via the local terminal. In the following examples, the new branch you would like to contribute to is referred to as `new_contribution_branch`.
Expand All @@ -110,7 +110,7 @@ We provide three methods for editing the Wiki pages: through `gollum` (recommend
- Click `Actions` > `Copy doc to wiki` > `Run workflow` > Choose `Branch: new_contribution_branch` > Click `Run workflow`. Once the workflow is complete, the Wiki will be updated to match `gamer/doc/wiki` on the `new_contribution_branch` branch.
- Clone your forked Wiki git. You may find the Wiki URL at the bottom right of the Wiki page.

[[images/WikiGitLocation.png]]
[[/images/WikiGitLocation.png]]

- Edit by `gollum`.
* NOTE: To use `gollum` for a branch other than `master` (e.g., `new_branch`), use the command `gollum --ref new_branch`.
Expand All @@ -122,7 +122,7 @@ We provide three methods for editing the Wiki pages: through `gollum` (recommend
This step is like `git push` to your branch.
* Click `Actions` > `Copy wiki to doc` > `Run workflow` > Choose `Branch: new_contribution_branch` > Click `Run workflow`. Once the workflow is complete, the content of `gamer/doc/wiki` in the `new_contribution_branch` branch will be updated to match the latest Wiki pages.

[[images/CopyWikiToNewBranch.png]]
[[/images/CopyWikiToNewBranch.png]]

1. **From GitHub website**

Expand All @@ -132,7 +132,7 @@ We provide three methods for editing the Wiki pages: through `gollum` (recommend
This step is like `git checkout new_contribution_branch` but for the GitHub Wiki website version.
* Click `Actions` > `Copy doc to wiki` > `Run workflow` > Choose `Branch: new_contribution_branch` > Click `Run workflow`. Once the workflow is complete, the Wiki will be updated to match `gamer/doc/wiki` on the `new_contribution_branch` branch.

[[images/CopyDocFromNewBranch.png]]
[[/images/CopyDocFromNewBranch.png]]

- **Edit directly on the GitHub Wiki website**

Expand All @@ -142,7 +142,7 @@ We provide three methods for editing the Wiki pages: through `gollum` (recommend
This step is like `git push` to your `new_contribution_branch` branch.
* Click `Actions` > `Copy wiki to doc` > `Run workflow` > Choose `Branch: new_contribution_branch` > Click `Run workflow`. Once the workflow is complete, the content of `gamer/doc/wiki` in the `new_contribution_branch` branch will be updated to match the latest Wiki pages.

[[images/CopyWikiToNewBranch.png]]
[[/images/CopyWikiToNewBranch.png]]

1. **On the local terminal**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ def yt_inline_inputArg( fields ):

Projection of field `Cloud01` along the z-axis:

[[images/InSitu_Projection_z_Cloud0.png | alt=insitu_projection]]
[[/images/InSitu_Projection_z_Cloud0.png | alt=insitu_projection]]


Particle plot using particle position x and y as axes with particle mass mapped to a colorbar:

[[images/InSitu_Particle_z_particle_mass.png | alt=insitu_particle]]
[[/images/InSitu_Particle_z_particle_mass.png | alt=insitu_particle]]

10. Since we have run libyt in interactive mode, the program should now pause and wait for user input.

Expand Down
2 changes: 1 addition & 1 deletion doc/wiki/Quick-Start-related/Quick-Start:-1D-Shock-Tube.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ display Fig__Riemann_Density_000010.png
<details>
<summary><u><i>Execution results</i></u></summary>

[[images/shocktube.png | alt=shocktube]]
[[/images/shocktube.png | alt=shocktube]]
</details>


Expand Down
2 changes: 1 addition & 1 deletion doc/wiki/Quick-Start-related/Quick-Start:-3D-Blast-Wave.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ display Data_000010_Slice_z_density.png
<details>
<summary><u><i>Execution results</i></u></summary>

[[images/blastwave.png | alt=blastwave]]
[[/images/blastwave.png | alt=blastwave]]
</details>

<br>
Expand Down
Binary file added doc/wiki/images/EnableWorkflows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 692d08a

Please sign in to comment.