Browse Source

/!\ To be merged when all/markdown_renderer is deployed

Markdown uses the characters '[' & ']' so it causes issues, use "{}" instead
pull/783/head
xpetit 4 years ago
parent
commit
0cf5ac638d
No known key found for this signature in database
GPG Key ID: 97C60669182C17A5
  1. 12
      docs/modular-steps-management.md
  2. 4
      docs/server-installation.md
  3. 2
      subjects/cl-camp4/README.md
  4. 8
      subjects/graphql/README.md
  5. 2
      subjects/hello-there/README.md
  6. 6
      subjects/hello_rust/README.md
  7. 2
      subjects/how-2-js/README.md
  8. 6
      subjects/introduction/README.md
  9. 2
      subjects/to-git-or-not-to-git/README.md
  10. 2
      subjects/who-are-you/README.md

12
docs/modular-steps-management.md

@ -69,12 +69,12 @@ In the step object you have created, 2 attributes must be filled:
- `onChange` prop are ignored as the event is handled by the app.
- For `switch` and `checkbox` input types, the default value has to be set as a boolean property named **value**.
- More information for each inputs is available in the design documentation:
- [textInput documentation](<https://((DOMAIN))/docs/Components/FormInputs/TextInput>) - used for inputs type 'text', 'tel', and 'date'
- [textArea documentation](<https://((DOMAIN))/docs/Components/FormInputs/TextArea>)
- [select documentation](<https://((DOMAIN))/docs/Components/FormControls/Select>)
- [radio button documentation](<https://((DOMAIN))/docs/Components/FormControls/Radio>)
- [switch documentation](<https://((DOMAIN))/docs/Components/FormControls/Switch>)
- [checkbox documentation](<https://((DOMAIN))/docs/Components/FormControls/Checkbox>)
- [textInput documentation](https://{{DOMAIN}}/docs/Components/FormInputs/TextInput) - used for inputs type 'text', 'tel', and 'date'
- [textArea documentation](https://{{DOMAIN}}/docs/Components/FormInputs/TextArea)
- [select documentation](https://{{DOMAIN}}/docs/Components/FormControls/Select)
- [radio button documentation](https://{{DOMAIN}}/docs/Components/FormControls/Radio)
- [switch documentation](https://{{DOMAIN}}/docs/Components/FormControls/Switch)
- [checkbox documentation](https://{{DOMAIN}}/docs/Components/FormControls/Checkbox)
### Examples

4
docs/server-installation.md

@ -6,8 +6,8 @@ One domain and one subdomain must point to the IP address of a [dedicated server
| FQDN | Record type | Address |
| -------------- | ----------- | ------- |
| ((DOMAIN)) | A | X.X.X.X |
| git.((DOMAIN)) | A | X.X.X.X |
| {{DOMAIN}} | A | X.X.X.X |
| git.{{DOMAIN}} | A | X.X.X.X |
## Network configuration

2
subjects/cl-camp4/README.md

@ -10,7 +10,7 @@ Create a file `myfamily.sh`, which will show a subject's family (key: relatives)
- The subject will be decided depending on his ID which will be contained in the environment variable HERO_ID.
* Where to look : https://[[DOMAIN]]/assets/superhero/all.json
* Where to look : https://{{DOMAIN}}/assets/superhero/all.json
* What to use : curl, jq and others...

8
subjects/graphql/README.md

@ -48,7 +48,7 @@ for example: [github-pages](https://pages.github.com/), [netlify](https://www.ne
### Usage
> To test your queries you can access the GraphQL IDE on _https://[[DOMAIN]]/public/subjects/graphql/_ or create your own [**GraphiQL Docs**](https://github.com/graphql/graphiql). This will give you a bigger picture of the tables, attributes and all the types of queries that you can do.
> To test your queries you can access the GraphQL IDE on _https://{{DOMAIN}}/public/subjects/graphql/_ or create your own [**GraphiQL Docs**](https://github.com/graphql/graphiql). This will give you a bigger picture of the tables, attributes and all the types of queries that you can do.
Here are the list of tables that you are allowed to query (it will be only provided the columns present on the tables):
@ -130,7 +130,7 @@ you could just add this attribute to the query, example:
You can try to `curl` the API endpoint to see the result given by the server:
- `curl "https://[[DOMAIN]]/api/graphql-engine/v1/graphql" --data '{"query":"{user{id login}}"}'`
- `curl "https://{{DOMAIN}}/api/graphql-engine/v1/graphql" --data '{"query":"{user{id login}}"}'`
Here is another example of a query using the table `user`:
@ -150,9 +150,9 @@ Here is another example of a query using the table `user`:
You can see the result using `curl`:
- `curl "https://[[DOMAIN]]/api/graphql-engine/v1/graphql" --data '{"query":"{user(where:{id:{_eq:6}}){id login}}"}'`
- `curl "https://{{DOMAIN}}/api/graphql-engine/v1/graphql" --data '{"query":"{user(where:{id:{_eq:6}}){id login}}"}'`
In graphQL the usage of arguments can be specified in the schema of the API. Like said above you can visit the _docs_ for the graphQL endpoint, _https://[[DOMAIN]]/public/subjects/grapqhl_
In graphQL the usage of arguments can be specified in the schema of the API. Like said above you can visit the _docs_ for the graphQL endpoint, _https://{{DOMAIN}}/public/subjects/grapqhl_
Example of nesting, using the result and user table :

2
subjects/hello-there/README.md

@ -108,7 +108,7 @@ executed.
### Instructions
Once you have installed and configured the necessary tools,
create a `git` repository named `[[ROOT]]` with a `hello-there.js`
create a `git` repository named `{{ROOT}}` with a `hello-there.js`
JS file that is a program that displays the exact text `Hello There !`, any `Number` and a
`Boolean`.

6
subjects/hello_rust/README.md

@ -10,7 +10,7 @@ Make sure those rules are followed consistenly during the whole piscine.
#### 1- get-ready
Create in your Gitea (https://git.[[DOMAIN]]) account the repository named `[[ROOT]]`.
Create in your [Gitea](https://git.{{DOMAIN}}) account the repository named `{{ROOT}}`.
This repository will be the folder where all the exercices must be uploaded.
@ -18,7 +18,7 @@ Once created, clone that repository on your desktop.
If your username was `choumi` this is the command that will need to be used :
`git clone git@git.[[DOMAIN]]:choumi/[[ROOT]].git`
`git clone git@git.{{DOMAIN}}:choumi/{{ROOT}}.git`
This command needs to be adapted with **your own username**.
@ -35,7 +35,7 @@ ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -N ''
cat ~/.ssh/id_ed25519.pub
```
- Copy the result and paste it in the content field of adding an SSH key in your Gitea settings : https://git.[[DOMAIN]]/user/settings/keys
- Copy the result and paste it in the content field of adding an SSH key in your Gitea settings : https://git.{{DOMAIN}}/user/settings/keys
- Confirm by clicking on the add key button.

2
subjects/how-2-js/README.md

@ -40,6 +40,6 @@ and you should see your hello world.
Great ! you are all set, if you want to re-execute your script, just refresh.
You now just have to create a repository named `[[ROOT]]`,
You now just have to create a repository named `{{ROOT}}`,
which will hold all your solutions for this piscine
and just add your 2 generated files to it, we will start slow for now... 🐢

6
subjects/introduction/README.md

@ -4,7 +4,7 @@
#### 1- get-ready
Create in your Gitea (https://git.[[DOMAIN]]) account the repository named `[[ROOT]]`.
Create in your [Gitea](https://git.{{DOMAIN}}) account the repository named `{{ROOT}}`.
This repository will be the folder where all the exercices must be uploaded.
@ -12,7 +12,7 @@ Once created, clone that repository on your desktop.
If your username was `choumi` this is the command that will need to be used :
`git clone git@git.[[DOMAIN]]:choumi/[[ROOT]].git`
`git clone git@git.{{DOMAIN}}:choumi/{{ROOT}}.git`
This command needs to be adapted with **your own username**.
@ -29,7 +29,7 @@ ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -N ''
cat ~/.ssh/id_ed25519.pub
```
- Copy the result and paste it in the content field of adding an SSH key in your Gitea settings : https://git.[[DOMAIN]]/user/settings/keys
- Copy the result and paste it in the content field of adding an SSH key in your Gitea settings : https://git.{{DOMAIN}}/user/settings/keys
- Confirm by clicking on the add key button.

2
subjects/to-git-or-not-to-git/README.md

@ -9,7 +9,7 @@ Only the numbers will appear.
Here is the base command that needs to be adapted with your username and more :
```
curl -s https://[[DOMAIN]]/api/graphql-engine/v1/graphql --data '{"query":"{user(where:{login:{_eq:\"choumi\"}}){id}}"}'
curl -s https://{{DOMAIN}}/api/graphql-engine/v1/graphql --data '{"query":"{user(where:{login:{_eq:\"choumi\"}}){id}}"}'
```
### Usage

2
subjects/who-are-you/README.md

@ -8,6 +8,6 @@ The only thought that comes to your mind is a tag that says: `subject Id: 70`"
Create the file `who-are-you.sh` which will remind you who you are by showing your name only.
- Where to look : [all.json](https://[[DOMAIN]]/assets/superhero/all.json)
- Where to look : https://{{DOMAIN}}/assets/superhero/all.json
- What to use : `curl` and `jq`

Loading…
Cancel
Save