~sircmpwn/public-inbox

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

[PATCH sr.ht-docs] fix link to api conventions

Details
Message ID
<20200503071123.556882380662@dd22736.kasserver.com>
DKIM signature
pass
Download raw message
Trying to get familiar with the sr.ht mechanisms i created a really small patch for https://todo.sr.ht/~sircmpwn/man.sr.ht/40

kind regards
René
Details
Message ID
<20200503091722.0d435d0c@swift3>
In-Reply-To
<20200503071123.556882380662@dd22736.kasserver.com> (view parent)
DKIM signature
pass
Download raw message
TIL: one should not add the patch file as an attachment. :)

From 2426f1a2f6681b66e3025a73647a6d7469cb1c72 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Wagner?= <rwagner@rw-net.de>
Date: Sun, 3 May 2020 08:58:42 +0200
Subject: [PATCH] fix link to api convention

---
 git.sr.ht/api.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/git.sr.ht/api.md b/git.sr.ht/api.md
index 6513ebb..a23f0c1 100644
--- a/git.sr.ht/api.md
+++ b/git.sr.ht/api.md
@@ -4,7 +4,7 @@ title: git.sr.ht API reference
 
 The git.sr.ht API allows you to browse, create, and manage
repositories on git.sr.ht programmatically. This API follows the
[standard sourcehut API -conventions](../api-conventions.md).
+conventions](https://man.sr.ht/api-conventions.md).
 
 **Notice**: the git.sr.ht API is due for an overhaul in the
foreseeable future; be prepared for it to change. The changes will be
announced in advance on the
-- 
2.26.2
Details
Message ID
<C2JP5LJGSBQU.1JGMNT0HVT69Q@homura>
In-Reply-To
<20200503071123.556882380662@dd22736.kasserver.com> (view parent)
DKIM signature
pass
Download raw message
Please resubmit this patch using git-send-email:

https://git-send-email.io

[PATCH sr.ht-docs] fixes ~sircmpwn/man.sr.ht#40: fix link to api-convention

Details
Message ID
<20200506184411.2175-1-rwagner@rw-net.de>
In-Reply-To
<C2JP5LJGSBQU.1JGMNT0HVT69Q@homura> (view parent)
DKIM signature
pass
Download raw message
Patch: +1 -1
---
 git.sr.ht/api.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/git.sr.ht/api.md b/git.sr.ht/api.md
index 6513ebb..a23f0c1 100644
--- a/git.sr.ht/api.md
+++ b/git.sr.ht/api.md
@@ -4,7 +4,7 @@ title: git.sr.ht API reference

The git.sr.ht API allows you to browse, create, and manage repositories on
git.sr.ht programmatically. This API follows the [standard sourcehut API
conventions](../api-conventions.md).
conventions](https://man.sr.ht/api-conventions.md).

**Notice**: the git.sr.ht API is due for an overhaul in the foreseeable future;
be prepared for it to change. The changes will be announced in advance on the
-- 
2.26.2

Re: [PATCH sr.ht-docs] fixes ~sircmpwn/man.sr.ht#40: fix link to api-convention

Details
Message ID
<C2KLKFGFC67T.1LTIMY2NMS16S@enki>
In-Reply-To
<20200506184411.2175-1-rwagner@rw-net.de> (view parent)
DKIM signature
pass
Download raw message
On Wed May 6, 2020 at 4:44 PM PST, René Wagner wrote:
> -conventions](../api-conventions.md).
> +conventions](https://man.sr.ht/api-conventions.md).
>  

Applying this as is would cause every deployment of man.sr.ht to link to
the sourcehut's main documentation rather than the documentation for
that instance.

Wouldn't it be better, since the api-conventions html is at the root to
just link it as (/api-conventions.md)?

Thanks,
Chris

Re: [PATCH sr.ht-docs] fixes ~sircmpwn/man.sr.ht#40: fix link to api-convention

Details
Message ID
<C2KLNS3FVIC7.2YGHQFWH2R3UL@homura>
In-Reply-To
<C2KLKFGFC67T.1LTIMY2NMS16S@enki> (view parent)
DKIM signature
pass
Download raw message
On Thu May 7, 2020 at 7:20 AM PST, Chris Vittal wrote:
> Applying this as is would cause every deployment of man.sr.ht to link to
> the sourcehut's main documentation rather than the documentation for
> that instance.

Well, every SourceHut instance runs the same software (in theory), so
they have compatible APIs. At least, it's in their interests to do that.
Details
Message ID
<20200507181551.9fa141bd428ce250c7262b17@rw-net.de>
In-Reply-To
<C2JP5LJGSBQU.1JGMNT0HVT69Q@homura> (view parent)
DKIM signature
pass
Download raw message
Hi!

I think i get your point, the docs are not currently  consistent in using 
relative or absolute uri tough - not only in respect to other man-pages 
but to services on sr.ht as well.
So actually anyone who's selfhosting needs to adjust the content of 
sr.ht-docs either way if they want to use Drews official docs.

kind regards
René
Review patch Export thread (mbox)