~sircmpwn/sr.ht-dev

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch
4 4

[PATCH sr.ht-docs] Fix some typos

Štěpán Němec
Details
Message ID
<20200325102236.1240037-1-stepnem@gmail.com>
DKIM signature
pass
Download raw message
Patch: +7 -7
---
 api-conventions.md                            | 6 +++---
 tutorials/builds.sr.ht/using-build-secrets.md | 6 +++---
 tutorials/getting-started-with-builds.md      | 2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/api-conventions.md b/api-conventions.md
index 44e78b1..eb5e6be 100644
--- a/api-conventions.md
+++ b/api-conventions.md
@@ -50,7 +50,7 @@ A singleton which is owned by `:resource`.

OR

A named action to be completed asyncronously.
A named action to be completed asynchronously.

### /api/:resource/:id/:subresource/:id

@@ -117,7 +117,7 @@ Errors are returned with a consistent response body:
    "errors": [
      {
        "field": "example",
        "reason": "example is requried"
        "reason": "example is required"
      }
    ]
  }
@@ -199,7 +199,7 @@ that occurred, e.g. `profile:update`.
The `X-Payload-Signature` and `X-Payload-Nonce` headers can be used to verify
the authenticity of the webhook payload. Concatenate the request body with the
nonce (treat the nonce as an ASCII-encoded string) and use it to verify the
base64-encoded Ed25519 siganture given by the `X-Payload-Signature` header. The
base64-encoded Ed25519 signature given by the `X-Payload-Signature` header. The
public key (also base64 encoded) is
`uX7KWyyDNMaBma4aVbJ/cbUQpdjqczuCyK/HxzV/u+4=`. Here's an example of verifying
the payload in Python:
diff --git a/tutorials/builds.sr.ht/using-build-secrets.md b/tutorials/builds.sr.ht/using-build-secrets.md
index bcd965e..4a6e5dd 100644
--- a/tutorials/builds.sr.ht/using-build-secrets.md
+++ b/tutorials/builds.sr.ht/using-build-secrets.md
@@ -10,7 +10,7 @@ available to CI jobs.
## Our example build manifest

Let's say we have a git repo with static HTML files that we'd like to deploy by
sending them to our webserver. A simple build manifest might look like this:
sending them to our web server. A simple build manifest might look like this:

```yml
image: alpine/edge
@@ -54,10 +54,10 @@ next step.

Go to the [builds.sr.ht secret management
dashboard](https://builds.sr.ht/secrets) and select "SSH key" for secret type,
then paste your key into the textbox. Click "submit" - and your new secret
then paste your key into the text box. Click "submit" - and your new secret
should show up on the right, along with its UUID.

This UUID is used to uniquely identify this secret in build manifets. Copy this
This UUID is used to uniquely identify this secret in build manifests. Copy this
UUID for the next step.

## Adding secrets to your build manifest
diff --git a/tutorials/getting-started-with-builds.md b/tutorials/getting-started-with-builds.md
index f902f01..b1440d2 100644
--- a/tutorials/getting-started-with-builds.md
+++ b/tutorials/getting-started-with-builds.md
@@ -3,7 +3,7 @@ title: Getting started with builds.sr.ht
---

builds.sr.ht is our build automation platform. We're going to walk through the
process of running jobs on builds.sr.ht and a look at few useful features.
process of running jobs on builds.sr.ht and a look at a few useful features.

## Build manifests

-- 
2.26.0
Details
Message ID
<C1JX0RMQ5PUZ.37OYGPFCET0ZK@homura>
In-Reply-To
<20200325102236.1240037-1-stepnem@gmail.com> (view parent)
DKIM signature
pass
Download raw message
Thank you!

To git.sr.ht:~sircmpwn/sr.ht-docs
   bc40c70..ef4f23f  master -> master

License detection

Details
Message ID
<c6c4f8c7-f7e9-19df-c97d-268e178200ba@neautomation.com>
In-Reply-To
<C1JX0RMQ5PUZ.37OYGPFCET0ZK@homura> (view parent)
DKIM signature
missing
Download raw message
I have a dual-licensed [project](https://git.sr.ht/~lucidone/ryo-iso)
and I'm getting
```
Heads up! We couldn't find a license file for your repository, which
means that it may not be possible for others to use this project. If
you're unsure of how to choose a license, consult our wiki page,
choosing a software license.
```

https://man.sr.ht/license.md
It has both
```
https://git.sr.ht/~lucidone/ryo-iso/tree/master/LICENSE-MIT
https://git.sr.ht/~lucidone/ryo-iso/tree/master/LICENSE-APACHE
```

Is there a preferred approach here?

On 3/25/20 8:30 AM, Drew DeVault wrote:
> Thank you!
> 
> To git.sr.ht:~sircmpwn/sr.ht-docs
>    bc40c70..ef4f23f  master -> master
> 

Re: License detection

Details
Message ID
<HRlDBT52qz-bVpgF8wXQS1iGu_e7nyrx2jT0SEwV9iOr52YaIOZELTZtOCxM_kGBVZ_vFRle92GjTuFu6_jxfg06Uf8b1u7NnC5CxAn0gec=@ashn.dev>
In-Reply-To
<c6c4f8c7-f7e9-19df-c97d-268e178200ba@neautomation.com> (view parent)
DKIM signature
pass
Download raw message
The same issue happens with use of the UNLICENSE which also doesn't
appear in the list of license names[1].
It's not the end of the world since that message is only shown to the
repo owner and not end-users, but it is still somewhat annoying to see
every time I look at my own repos.

[1]: https://git.sr.ht/~sircmpwn/git.sr.ht/tree/master/gitsrht/blueprints/repo.py#L112

Re: License detection

Details
Message ID
<b64a070760720557fbd3a723b5913c962f1aed12.camel@ben.gmbh>
In-Reply-To
<c6c4f8c7-f7e9-19df-c97d-268e178200ba@neautomation.com> (view parent)
DKIM signature
pass
Download raw message
> It has both
> ```
> https://git.sr.ht/~lucidone/ryo-iso/tree/master/LICENSE-MIT
> https://git.sr.ht/~lucidone/ryo-iso/tree/master/LICENSE-APACHE
> ```
> 
> Is there a preferred approach here?
Here's the list of files git.sr.ht checks for:
                "LICENSE", "LICENCE", "COPYING",
                "LICENSE.txt", "license.txt",
                "LICENCE.txt", "licence.txt",
                "COPYING.txt", "copying.txt",
                "LICENSE.md", "license.md",
                "LICENCE.md", "licence.md",
                "COPYING.md", "copying.md",
                "LICENSES", "licenses",
                "LICENCES", "licences",
I think the best strategy here is to create a "LICENSE" file that
explains your dual licensing strategy. Or just ignore the scary
warning, it only shows up for you.
Reply to thread Export thread (mbox)