-
-
Notifications
You must be signed in to change notification settings - Fork 29
docs: cms contribution guide #1137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
a4202d8
docs: cms contribution guide
lenderom 2d23295
fix: add github url
lenderom c04d269
Merge branch 'main' into docs/cms-contribution-guide
lenderom 1641f56
fix: workaround
lenderom 520d163
fix: update hugo version
lenderom e29e841
fix: add fork hint
lenderom 0319a6a
fix: debug
lenderom 5d1601b
fix: debug
lenderom ac33874
fix: update links
lenderom a6b6aa8
fix: debug
lenderom 7832512
fix: test links
lenderom 5ce1e8c
fix: add image translations
lenderom f02702b
fix: Internal links to static pages
MoritzWeber0 f8ae9a7
fix: correct typos and improve wording in contribution guides
lenderom 0bfbfb2
Merge branch 'docs/cms-contribution-guide' of github.com:fipguide/fip…
lenderom File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| --- | ||
| draft: false | ||
| title: "Beitragen" | ||
| type: "general/generalinformation" | ||
| --- | ||
|
|
||
| Der _FIP Guide_ ist ein Open-Source und Community-Projekt. Wenn du Informationen aktualisieren oder hinzufügen möchtest, kannst du dies selbständig tun. Um die Richtigkeit der Informationen sicherzustellen, werden alle Änderungen vom FIP Guide Team überprüft, bevor sie veröffentlicht werden. | ||
|
|
||
| Seiten können direkt im FIP Guide über das [Content-Management-System (CMS)](https://www.fipguide.org/admin) angepasst werden. Mehr dazu im Abschnitt [Direkte Bearbeitung](#direkte-bearbeitung). Wenn du schon technisches Hintergrundwissen hast, kannst du Änderungen direkt über GitHub vornehmen, mehr dazu unter [GitHub Contribution](#github-contribution). | ||
|
|
||
| ## Direkte Bearbeitung | ||
|
|
||
| Über das Content-Management-System (CMS) kannst du direkt die Inhalte der Seiten bearbeiten. Diese ist unter [fipguide.org/admin](https://www.fipguide.org/admin) erreichbar. | ||
|
|
||
| Bitte beachte folgende Punkte bei der Bearbeitung: | ||
|
|
||
| ### Anmeldung | ||
|
|
||
| {{% float-image | ||
| src="login.webp" | ||
| alt="FIP Guide CMS Login" | ||
| width="30%" | ||
| position="left" | ||
| %}} | ||
| Um dich im FIP Guide CMS anzumelden, benötigst du einen kostenlosen [GitHub](https://github.com/) Account. GitHub gehört zu Microsoft und ist eine Plattform zur Kollaboration in Open-Source-Projekten. Den GitHub Account kannst du einfach auf der [GitHub Website](https://github.com/) erstellen. | ||
|
|
||
| Im CMS kann sich mit diesem GitHub Account angemeldet werden. Während der Anmeldung muss die Nutzung mit "Authorize" bestätigt werden. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight important %}} | ||
| Bei der erstmaligen Anmeldung wird gefragt, ob ein sogenannter _Fork_ erstellt werden soll. Dadurch wird automatisch eine eigene Kopie der Seite erstellt. Dies ist notwendig, damit Änderungen im CMS gespeichert werden können. Bitte bestätige dies mit "Create Fork". | ||
| {{% /highlight %}} | ||
|
|
||
| ### Seiten öffnen | ||
|
|
||
| Auf der [Startseite](https://www.fipguide.org/admin) des FIP Guide CMS kann im linken Menü die Seitenkategorie ausgewählt und anschließend in der Mitte die gewünschte Seite geöffnet oder eine neue Seite erstellt werden. | ||
|
|
||
|  | ||
|
|
||
| Alternativ kann auch über den FIP Guide die zu bearbeitende Seite geöffnet werden und anschließend über das Menü "Seite bearbeiten" über das CMS modifiziert werden. | ||
|
|
||
| {{% columns %}} | ||
| {{% column width="50%" %}} | ||
|  | ||
| {{% /column %}} | ||
| {{% column width="50%" %}} | ||
|  | ||
| {{% /column %}} | ||
| {{% /columns %}} | ||
|
|
||
| ### Seite bearbeiten | ||
|
|
||
| {{% float-image | ||
| src="language.webp" | ||
| alt="FIP Guide CMS Sprache auswählen" | ||
| width="40%" | ||
| position="right" | ||
| %}} | ||
| In der Bearbeitungsansicht kann die entsprechende Seite aktualisiert werden. Der FIP Guide ist in verschiedenen Sprachen verfügbar. Diese können über das entsprechende Drop-Down-Menü ausgewählt werden. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight tip %}} | ||
| Wenn du möchtest, kannst du selbstständig alle Sprachen der Seite aktualisieren. Das ist jedoch nicht unbedingt notwendig. Du kannst auch Informationen nur in einer Sprache aktualisieren. Das FIP Guide Team wird die Änderungen überprüfen und anschließend die Informationen in allen Sprachen aktualisieren. | ||
| {{% /highlight %}} | ||
|
|
||
| {{% float-image | ||
| src="language-view.webp" | ||
| alt="FIP Guide CMS Sprach-Ansicht umstellen" | ||
| width="15%" | ||
| position="left" | ||
| %}} | ||
| Über das Seiten-Symbol auf der rechten Seite kann die Ansicht zwischen _mehrsprachig_ und _einsprachig_ umgestellt werden. | ||
| {{% /float-image %}} | ||
|
|
||
| ### Änderungen speichern und veröffentlichen | ||
|
|
||
| {{% float-image | ||
| src="save.webp" | ||
| alt="FIP Guide CMS Änderungen speichern" | ||
| width="50%" | ||
| position="right" | ||
| %}} | ||
| Wenn du deine Arbeiten unterbrechen und speichern möchtest, kannst du dies über den _Save_ Button tun. Die Änderungen werden dann im CMS gespeichert, damit du sie später weiter bearbeiten kannst, jedoch noch nicht veröffentlicht. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% float-image | ||
| src="status-review.webp" | ||
| alt="FIP Guide CMS Status auf Review setzen" | ||
| width="40%" | ||
| position="left" | ||
| %}} | ||
| Wenn du deine Änderungen veröffentlichen möchtest, kannst du den Status der Seite auf _Review_ setzen. Das FIP Guide Team wird die Änderungen überprüfen und anschließend veröffentlichen. Solange die Änderungen nicht veröffentlicht wurden, können die Seiten jederzeit bearbeitet werden. | ||
| {{% /float-image %}} | ||
|
|
||
| Jede Änderung, die in den Status _Review_ gesetzt wurde, ist auf GitHub sichtbar: [FIP Guide GitHub Änderungen (Pull Requests)](https://github.com/fipguide/fipguide.github.io/pulls). Hier ist auch deine Anpassung sichtbar und es können Kommentare zur Änderung hinterlassen werden. Das FIP Guide Team prüft die Änderungen und stellt bei Bedarf über die Kommentarfunktion Rückfragen. | ||
|
|
||
| ### Arbeit fortsetzen / Überblick über Änderungen | ||
|
|
||
| {{% float-image | ||
| src="workflow.webp" | ||
| alt="FIP Guide CMS Workflow" | ||
| width="60%" | ||
| position="right" | ||
| %}} | ||
| Wenn du deine Arbeit an einer Seite gespeichert hast und fortsetzen willst oder einen Überblick über den Status all deiner Änderungen haben möchtest, kannst du dies über den Menüpunkt _Workflow_ tun. | ||
|
|
||
| - **Draft:** Änderungen, an denen noch gearbeitet wird und noch nicht bereit zum Review sind. | ||
| - **Review:** Änderungen, die vom FIP Guide Team überprüft werden. | ||
| - **Ready:** Änderungen, die vom FIP Guide Team überprüft wurden und in Kürze veröffentlicht werden. | ||
| {{% /float-image %}} | ||
|
|
||
| ### Preview | ||
|
|
||
| {{% float-image | ||
| src="preview.webp" | ||
| alt="FIP Guide CMS Preview" | ||
| width="50%" | ||
| position="right" | ||
| %}} | ||
| Nachdem Änderungen im CMS gespeichert wurden, kann eine Preview der Seite angesehen werden, auf der die eigenen Änderungen bereits sichtbar sind. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight important %}} | ||
| Das Erzeugen der Preview kann 5-10 Minuten in Anspruch nehmen! | ||
| {{% /highlight %}} | ||
|
|
||
| Über _Check for Preview_ kann geprüft werden, ob die Preview bereits erzeugt wurde. Die Preview wird bei jeder Anpassung neu erzeugt, bleibt aber bestehen, wenn die Änderungen zu einem späteren Zeitpunkt fortgesetzt werden. | ||
|
|
||
| ## GitHub Contribution | ||
|
|
||
| Der FIP Guide nutzt den Static Website Generator [_Hugo_](https://gohugo.io/) zum Erstellen der Website. Die Seite kann direkt in [GitHub](https://github.com/fipguide/fipguide.github.io/) über die Web-IDE oder deine lokale Entwicklungsumgebung bearbeitet werden. Weitere Informationen und Hilfe sind im [GitHub Wiki](https://github.com/fipguide/fipguide.github.io/wiki) und [Contribution-Guide](https://github.com/fipguide/fipguide.github.io/blob/main/CONTRIBUTING.md) verfügbar. | ||
|
|
||
| ## Unterstützung | ||
|
|
||
| Wenn du Hilfe bei der Bearbeitung benötigst, kannst du dich jederzeit per Mail oder über die FIP Guide Community bei uns melden. Weitere Informationen dazu findest du auf der [Kontakt-Seite](/contact). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| --- | ||
| draft: false | ||
| title: "Contribution" | ||
| type: "general/generalinformation" | ||
| --- | ||
|
|
||
| The _FIP Guide_ is an open-source and community project. If you would like to update or add information, you can do this independently. To ensure the accuracy of the information, all changes are reviewed by the FIP Guide team before they are published. | ||
|
|
||
| Pages can be adjusted directly in the FIP Guide via the [Content Management System (CMS)](https://www.fipguide.org/admin). More about this in the section [Direct Editing](#direct-editing). If you already have technical background knowledge, you can make changes directly via GitHub, more about this under [GitHub Contribution](#github-contribution). | ||
|
|
||
| ## Direct Editing | ||
|
|
||
| You can edit the content of the pages directly via the Content Management System (CMS). It is available at [fipguide.org/admin](https://www.fipguide.org/admin). | ||
|
|
||
| Please note the following points when editing: | ||
|
|
||
| ### Login | ||
|
|
||
| {{% float-image | ||
| src="login.webp" | ||
| alt="FIP Guide CMS login" | ||
| width="30%" | ||
| position="left" | ||
| %}} | ||
| To log in to the FIP Guide CMS, you need a free [GitHub](https://github.com/) account. GitHub belongs to Microsoft and is a platform for collaboration in open-source projects. You can easily create the GitHub account on the [GitHub website](https://github.com/). | ||
|
|
||
| You can log in to the CMS with this GitHub account. During the login, the use must be confirmed with "Authorize". | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight important %}} | ||
| When you log in for the first time, you will be asked whether a so-called _Fork_ should be created. This automatically creates your own copy of the page. This is necessary so that changes can be saved in the CMS. Please confirm this with "Create Fork". | ||
| {{% /highlight %}} | ||
|
|
||
| ### Open Pages | ||
|
|
||
| On the [homepage](https://www.fipguide.org/admin) of the FIP Guide CMS, the page category can be selected in the left menu and then the desired page can be opened in the center or a new page can be created. | ||
|
|
||
|  | ||
|
|
||
| Alternatively, the page to be edited can also be opened via the FIP Guide and then modified via the CMS using the "Edit page" menu. | ||
|
|
||
| {{% columns %}} | ||
| {{% column width="50%" %}} | ||
|  | ||
| {{% /column %}} | ||
| {{% column width="50%" %}} | ||
|  | ||
| {{% /column %}} | ||
| {{% /columns %}} | ||
|
|
||
| ### Edit Page | ||
|
|
||
| {{% float-image | ||
| src="language.webp" | ||
| alt="Select language in FIP Guide CMS" | ||
| width="40%" | ||
| position="right" | ||
| %}} | ||
| In the editing view, the corresponding page can be updated. The FIP Guide is available in different languages. These can be selected via the corresponding drop-down menu. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight tip %}} | ||
| If you want, you can independently update all languages of the page. However, this is not absolutely necessary. You can also update information in only one language. The FIP Guide team will review the changes and then update the information in all languages. | ||
| {{% /highlight %}} | ||
|
|
||
| {{% float-image | ||
| src="language-view.webp" | ||
| alt="Switch language view in FIP Guide CMS" | ||
| width="15%" | ||
| position="left" | ||
| %}} | ||
| Using the page icon on the right side, the view can be switched between _multilingual_ and _single-language_. | ||
| {{% /float-image %}} | ||
|
|
||
| ### Save and Publish Changes | ||
|
|
||
| {{% float-image | ||
| src="save.webp" | ||
| alt="Save changes in FIP Guide CMS" | ||
| width="50%" | ||
| position="right" | ||
| %}} | ||
| If you want to pause your work and save it, you can do this via the _Save_ button. The changes are then saved in the CMS so that you can continue editing them later, but they are not yet published. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% float-image | ||
| src="status-review.webp" | ||
| alt="Set status to review in FIP Guide CMS" | ||
| width="40%" | ||
| position="left" | ||
| %}} | ||
| If you want to publish your changes, you can set the status of the page to _Review_. The FIP Guide team will review the changes and then publish them. As long as the changes have not been published, the pages can be edited at any time. | ||
| {{% /float-image %}} | ||
|
|
||
| Every change that has been set to the _Review_ status is visible on GitHub: [FIP Guide GitHub changes (pull requests)](https://github.com/fipguide/fipguide.github.io/pulls). Your change is also visible there and comments can be left on the change. The FIP Guide team reviews the changes and, if necessary, asks questions via the comment function. | ||
|
|
||
| ### Continue Working / Overview of Changes | ||
|
|
||
| {{% float-image | ||
| src="workflow.webp" | ||
| alt="FIP Guide CMS workflow" | ||
| width="60%" | ||
| position="right" | ||
| %}} | ||
| If you have saved your work on a page and want to continue, or if you want an overview of the status of all your changes, you can do this via the _Workflow_ menu item. | ||
|
|
||
| - **Draft:** Changes that are still being worked on and are not yet ready for review. | ||
| - **Review:** Changes that are being reviewed by the FIP Guide team. | ||
| - **Ready:** Changes that have been reviewed by the FIP Guide team and will be published shortly. | ||
| {{% /float-image %}} | ||
|
|
||
| ### Preview | ||
|
|
||
| {{% float-image | ||
| src="preview.webp" | ||
| alt="FIP Guide CMS preview" | ||
| width="50%" | ||
| position="right" | ||
| %}} | ||
| After changes have been saved in the CMS, a preview of the page can be viewed in which your own changes are already visible. | ||
| {{% /float-image %}} | ||
|
|
||
| {{% highlight important %}} | ||
| Generating the preview can take 5-10 minutes! | ||
| {{% /highlight %}} | ||
|
|
||
| Use _Check for Preview_ to check whether the preview has already been generated. The preview is regenerated with every adjustment, but remains available if the changes are continued at a later point in time. | ||
|
|
||
| ## GitHub Contribution | ||
|
|
||
| The FIP Guide uses the static website generator [_Hugo_](https://gohugo.io/) to create the website. The page can be edited directly in [GitHub](https://github.com/fipguide/fipguide.github.io/) via the web IDE or your local development environment. Further information and help are available in the [GitHub wiki](https://github.com/fipguide/fipguide.github.io/wiki) and [contribution guide](https://github.com/fipguide/fipguide.github.io/blob/main/CONTRIBUTING.md). | ||
|
|
||
| ## Support | ||
|
|
||
| If you need help with editing, you can contact us at any time by email or via the FIP Guide Community. Further information can be found on the [contact page](/contact). | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.