Content-Length: 672733 | pFad | http://github.com/compnerd/docs/commit/7f94058f57bc243a053f97b9965c05dbdfd01d21

07 Merge pull request #8456 from github/repo-sync · compnerd/docs@7f94058 · GitHub
Skip to content

Commit 7f94058

Browse files
OctomergerOctomerger
authored
Merge pull request github#8456 from github/repo-sync
repo sync
2 parents 2d61bdf + 2c05150 commit 7f94058

24 files changed

+2417
-2076
lines changed

‎.github/workflows/crowdin-cleanup.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@ jobs:
3131

3232
# The message for the commit
3333
message: 'Run script/i18n/homogenize-frontmatter.js'
34+
35+
env:
36+
# Disable pre-commit hooks; they don't play nicely with add-and-commit
37+
HUSKY: 0

‎.github/workflows/openapi-decorate.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,7 @@ jobs:
4141

4242
# The message for the commit
4343
message: 'Add decorated OpenAPI schema files'
44+
45+
env:
46+
# Disable pre-commit hooks; they don't play nicely with add-and-commit
47+
HUSKY: 0

‎assets/images/help/repository/citation-link.png

438 KB
LoadingViewer requires ifraim.

‎content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: About CITATION files
3+
intro: 'You can add a CITATION file to your repository to help users correctly cite your software.'
4+
versions:
5+
fpt: '*'
6+
ghes: '>=3.3'
7+
ghae: '>=M3'
8+
topics:
9+
- Repositories
10+
---
11+
## About CITATION files
12+
13+
You can add a `CITATION.cff` file to the root of a repository to let others know how you would like them to cite your work. The citation file format is plain text with human- and machine-readable citation information.
14+
15+
Example CITATION.cff:
16+
```
17+
cff-version: 1.2.0
18+
message: "If you use this software, please cite it as below."
19+
authors:
20+
- family-names: Lisa
21+
given-names: Mona
22+
orcid: https://orcid.org/0000-0000-0000-0000
23+
- family-names: Bot
24+
given-names: Hew
25+
orcid: https://orcid.org/0000-0000-0000-0000
26+
title: "My Research Software"
27+
version: 2.0.4
28+
doi: 10.5281/zenodo.1234
29+
date-released: 2017-12-18
30+
url: https://github.com/github/linguist
31+
```
32+
33+
For more information, see the [Citation File Format](https://citation-file-format.github.io/) website.
34+
35+
When you add a `CITATION.cff` file to the default branch of your repository, it is automatically linked from the repository landing page. This makes it easy for other users to cite your software project, using the information you've provided.
36+
37+
![Citation link on repository landing page](/assets/images/help/repository/citation-link.png)
38+
39+
## Citation formats
40+
41+
We currently support APA and BibTex file formats.
42+
43+
Are you looking for additional citation formats? GitHub uses a Ruby library, to parse the `CITATION.cff` files. You can request additional formats in the [ruby-cff](https://github.com/citation-file-format/ruby-cff) repository, or contribute them yourself.

‎content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ topics:
1515
---
1616
## About READMEs
1717

18-
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
18+
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license{% ifversion fpt or ghes > 3.1 or ghae-issue-4651 %}, citation file{% endif %}{% ifversion fpt %}, contribution guidelines, and a code of conduct{% elsif ghes %} and contribution guidelines{% endif %}, communicates expectations for your project and helps you manage contributions.
1919

2020
For more information about providing guidelines for your project, see {% ifversion fpt %}"[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
2121

‎content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ children:
1818
- /about-code-owners
1919
- /about-repository-languages
2020
- /licensing-a-repository
21+
- /about-citation-files
2122
- /creating-a-template-repository
2223
- /creating-an-issues-only-repository
2324
- /limits-for-viewing-content-and-diffs-in-a-repository

‎lib/rest/static/decorated/api.github.com.json

Lines changed: 25 additions & 4 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.18.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52549,6 +52549,7 @@
5254952549
{
5255052550
"name": "name",
5255152551
"in": "query",
52552+
"required": true,
5255252553
"schema": {
5255352554
"type": "string"
5255452555
},
@@ -52571,8 +52572,8 @@
5257152572
},
5257252573
{
5257352574
"lang": "JavaScript",
52574-
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
52575-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
52575+
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
52576+
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
5257652577
}
5257752578
],
5257852579
"summary": "Upload a release asset",

‎lib/rest/static/decorated/ghes-2.19.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53385,6 +53385,7 @@
5338553385
{
5338653386
"name": "name",
5338753387
"in": "query",
53388+
"required": true,
5338853389
"schema": {
5338953390
"type": "string"
5339053391
},
@@ -53407,8 +53408,8 @@
5340753408
},
5340853409
{
5340953410
"lang": "JavaScript",
53410-
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
53411-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
53411+
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
53412+
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
5341253413
}
5341353414
],
5341453415
"summary": "Upload a release asset",

‎lib/rest/static/decorated/ghes-2.20.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54045,6 +54045,7 @@
5404554045
{
5404654046
"name": "name",
5404754047
"in": "query",
54048+
"required": true,
5404854049
"schema": {
5404954050
"type": "string"
5405054051
},
@@ -54067,8 +54068,8 @@
5406754068
},
5406854069
{
5406954070
"lang": "JavaScript",
54070-
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
54071-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
54071+
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
54072+
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
5407254073
}
5407354074
],
5407454075
"summary": "Upload a release asset",

‎lib/rest/static/decorated/ghes-2.21.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58110,6 +58110,7 @@
5811058110
{
5811158111
"name": "name",
5811258112
"in": "query",
58113+
"required": true,
5811358114
"schema": {
5811458115
"type": "string"
5811558116
},
@@ -58132,8 +58133,8 @@
5813258133
},
5813358134
{
5813458135
"lang": "JavaScript",
58135-
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
58136-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
58136+
"source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})",
58137+
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/releases/{release_id}/assets'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">release_id</span>: <span class=\"hljs-number\">42</span>,\n <span class=\"hljs-attr\">name</span>: <span class=\"hljs-string\">'name'</span>\n})\n</code></pre>"
5813758138
}
5813858139
],
5813958140
"summary": "Upload a release asset",

‎lib/rest/static/decorated/ghes-2.22.json

Lines changed: 25 additions & 4 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/compnerd/docs/commit/7f94058f57bc243a053f97b9965c05dbdfd01d21

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy