-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instruction on how to encode links and upload images
- Loading branch information
1 parent
97d1545
commit b2e84b8
Showing
1 changed file
with
15 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,13 +1,15 @@ | ||
| <h1 id="how-to-report-new-country-fiche">How to report new Country fiche</h1> | ||
| <p>To report a new Country fiche for your Member State, please follow the instructions below:</p> | ||
| <ul> | ||
| <li>Fork the INSPIRE-in-your-Country repository (For more information, see "<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks">Working with forks</a>").</li> | ||
| <li>In the forked repository, create a new Markdown <em>.md</em> file in the folder related to your country, e.g. <em>/INSPIRE-in-your-Country/AT/Country_fiches/</em> (For more information, see "<a href="https://docs.github.com/en/repositories/working-with-files/managing-files/creating-new-files">Creating new files</a>"), with the following characteristics:<ul> | ||
| <li>the file name should follow the following naming structure "<em><MS-code>-Country_fiche-<Year>.md</em>", e.g. <em>AT-Country_fiches-2024.md</em>.</li> | ||
| <li>the document structure should follow the <a href="https://raw.githubusercontent.com/INSPIRE-MIF/INSPIRE-in-your-Country/main/how-to-report-new-CF/Country_fiche_Template.md">country fiche template</a> (you can copy/paste the markdown syntax).</li> | ||
| </ul> | ||
| </li> | ||
| <li>Edit your new country fiche (For more information on the use of the Markdown syntax, see "<a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax">Basic writing and formatting syntax</a>") and commit your changes.</li> | ||
| <li>When finished, create a pull request to propose changes you've made to the fork of the INSPIRE-in-your-Country repository (For more information, see "<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">Creating a pull request from a fork</a>").</li> | ||
| </ul> | ||
| <p>Use the <a href="https://github.com/INSPIRE-MIF/INSPIRE-in-your-Country/issues/new"><em>Issue tracker</em></a> to report issues with this procedure.</p> | ||
| How to report new Country fiche | ||
| =============================== | ||
|
|
||
| To report a new Country fiche for your Member State, please follow the instructions below: | ||
|
|
||
| * Fork the INSPIRE-in-your-Country repository (For more information, see "[Working with forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks)"). | ||
| * In the forked repository, create a new Markdown _.md_ file in the folder related to your country, e.g. _/INSPIRE-in-your-Country/AT/Country\_fiches/_ (For more information, see "[Creating new files](https://docs.github.com/en/repositories/working-with-files/managing-files/creating-new-files)"), with the following characteristics: | ||
| * the file name should follow the following naming structure "_<MS-code>-Country\_fiche-<Year>.md_", e.g. _AT-Country\_fiches-2024.md_. | ||
| * the document structure should follow the [country fiche template](https://raw.githubusercontent.com/INSPIRE-MIF/INSPIRE-in-your-Country/main/how-to-report-new-CF/Country_fiche_Template.md) (you can copy/paste the markdown syntax). | ||
| * Edit your new country fiche and commit your changes (For more information on the use of the Markdown syntax, see "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)"), in particular: | ||
| * make sure that links are encoded using the proper syntax, i.e. _\[link text](URL)_, otherwise, they are not converted as hyperlinks by GitHub pages. | ||
| * to insert an image, create a folder "_images_" in your "_Country_fiches_" folder, upload the image and refer to it using the following syntax: _\!\[Image Alt Text](images/image-name.png)_ | ||
| * When finished, create a pull request to propose changes you've made to the fork of the INSPIRE-in-your-Country repository (For more information, see "[Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"). | ||
|
|
||
| Use the [_Issue tracker_](https://github.com/INSPIRE-MIF/INSPIRE-in-your-Country/issues/new) to report issues with this procedure. |