|
| 1 | +--- |
| 2 | +title: "How to add yourself to the member list" |
| 3 | +groupByYear: false |
| 4 | +showAuthor: true |
| 5 | +showTableOfContents: true |
| 6 | +authors: |
| 7 | + - "jpthiele" |
| 8 | +date: 2025-05-20 |
| 9 | +--- |
| 10 | + |
| 11 | +## (Optional) install Hugo |
| 12 | +This website is build using [*Hugo*](https://gohugo.io) which comes as a single executable, |
| 13 | +without the need to install anything else. |
| 14 | +This can be very helpful if you want to get a preview of your changes, |
| 15 | +especially when cropping/resizing your image. |
| 16 | + |
| 17 | +The first step is to follow the instructions at |
| 18 | + |
| 19 | +{{< button href="https://gohugo.io/installation/" >}} |
| 20 | +Install Hugo |
| 21 | +{{< /button>}} |
| 22 | + |
| 23 | + |
| 24 | +## Fork the repository |
| 25 | +Go to the [GitHub repository {{<icon "github">}} ](https://github.com/GAMM-AG-RSE-RDM/GAMM-AG-RSE-RDM.github.io) and click on the *Fork* button. |
| 26 | + |
| 27 | +This will add a linked copy of the repository into your 'user space', e.g.<br> github.com/jpthiele/GAMM-AG-RSE-RDM.github.io |
| 28 | + |
| 29 | +## Clone the repository |
| 30 | +On your fork click on the code button and copy the |
| 31 | +SSH link. |
| 32 | +In your terminal/console navigate to a folder where you want to download the repository into and type |
| 33 | +```bash |
| 34 | +git clone <link> |
| 35 | +``` |
| 36 | +change into the new folder and switch to a new branch |
| 37 | +```bash |
| 38 | +git switch --create <branch_name> |
| 39 | +``` |
| 40 | +For *<branch_name>* you can choose whatever makes sense to you, e.g. *member_jpthiele* |
| 41 | + |
| 42 | +If you installed Hugo earlier you can start a local live server by calling |
| 43 | +```bash |
| 44 | +hugo server |
| 45 | +``` |
| 46 | +The command will rebuild the site on changes, |
| 47 | +so you can see directly what happens. |
| 48 | + |
| 49 | +## Add yourself to the list |
| 50 | + |
| 51 | +Start by adding a folder inside *content/members*. |
| 52 | +Technically, the name of the folder is not important but it would help us to use a recognizable name |
| 53 | +such as your initials and last name or your GitHub user name, etc. |
| 54 | + |
| 55 | + |
| 56 | +### Add your information |
| 57 | + |
| 58 | +Inside the new folder add a file *index.md* |
| 59 | +and replace the angle brackets with the matching information. |
| 60 | + |
| 61 | +```md |
| 62 | +--- |
| 63 | +title: "<Your_Name>" |
| 64 | +tags: ["<tag_1>","<tag_2>","<tag_3>",...] |
| 65 | +externalUrl: "<link_to_your_website>" |
| 66 | +showTaxonomies: true |
| 67 | +showDate: false |
| 68 | +weight: 1 |
| 69 | +--- |
| 70 | + |
| 71 | +``` |
| 72 | + |
| 73 | +The tags are used to show everyone what related initiatives and organizations |
| 74 | +you are a part of. |
| 75 | +If you don't want to add any you can remove the whole line. |
| 76 | + |
| 77 | + |
| 78 | +As an example my *index.md* looks like this: |
| 79 | +```md |
| 80 | +--- |
| 81 | +title: "Jan Philipp Thiele" |
| 82 | +tags: ["Chair","GAMM member","de-RSE member"] |
| 83 | +externalUrl: "https://github.com/jpthiele" |
| 84 | +showTaxonomies: true |
| 85 | +showDate: false |
| 86 | +weight: 0 # so chairs are in the front |
| 87 | +--- |
| 88 | +``` |
| 89 | + |
| 90 | +### (Optional) Add an image of yourself. |
| 91 | + |
| 92 | +{{< alert >}} |
| 93 | +**Only use an image for which you have the proper usage rights!** |
| 94 | +{{</ alert >}} |
| 95 | + |
| 96 | +There are two option for adding the image |
| 97 | + |
| 98 | +1. Add a link to the image by adding the parameter |
| 99 | + ```md |
| 100 | + featureimage: "<URL>" |
| 101 | + ``` |
| 102 | + inside *index.md*, but **before** the second set of three dashes |
| 103 | + |
| 104 | +2. Add an image file named *featured.jpg* or *featured.png* inside your member folder. |
| 105 | + |
| 106 | + |
| 107 | +## Commit & Push changes and open a pull request |
| 108 | + |
| 109 | +Just in case, type |
| 110 | +```bash |
| 111 | +git branch |
| 112 | +``` |
| 113 | +and make sure that you are not on the main branch, |
| 114 | +but on a different branch, e.g. *member_jpthiele* |
| 115 | + |
| 116 | + |
| 117 | +Add the newly created member folder and commit your changes, e.g. |
| 118 | +```bash |
| 119 | +git add content/members/jpthiele |
| 120 | +git commit -m "[Members] add Jan Philipp Thiele" |
| 121 | +``` |
| 122 | +The *[Members]* start of the commit message helps us |
| 123 | +with keeping track, so please use it. |
| 124 | + |
| 125 | +Once done you have to push your branch to your fork |
| 126 | +```bash |
| 127 | +git push -u origin member_jpthiele |
| 128 | +``` |
| 129 | +To open the pull request directly you can click on the link in the command output. |
| 130 | + |
| 131 | + |
| 132 | +## Don't forget to join the mailing list |
| 133 | + |
| 134 | +To keep up to date with discussions you should also |
| 135 | + |
| 136 | +{{< button href="https://www.listserv.dfn.de/sympa/subscribe/gamm-rse%2Brdm">}} |
| 137 | +Join the GAMM RSE & RDM mailing list |
| 138 | +{{</ button >}} |
| 139 | + |
| 140 | +if not done already. |
| 141 | + |
| 142 | +## Anything unclear? |
| 143 | + |
| 144 | +If yes feel free to reach out, e.g. by [*opening an issue*{{<icon "github">}}](https://github.com/GAMM-AG-RSE-RDM/GAMM-AG-RSE-RDM.github.io/issues/new) |
| 145 | +and do feel free to ping me by adding @jpthiele to the issue. |
0 commit comments