Hi Karen,
replying to two emails with one :)
On Wed, May 5, 2021 at 7:41 PM Karen Lease <karenlease...@gmail.com> wrote:
> Footnotes in a mail--I'm impressed! Thanks again for the excellent
> mentoring.
:) thank you for taking the time to discuss changes, and being very thorough!
> Everything is clear except the contributing.md which is still a bit
> fuzzy for me.
>
> I now understand why there should be a CONTRIBUTING.md at the root of
> the repository, but when you say "and just point to the website from
> there", I'm not sure what you mean. Do you mean having a minimum
> CONTRIBUTING.md file at the root which just links to
> community/contributing.md which has the full content?
My initial thought was to have a link in the /CONTRIBUTING.md to the
website (camel.apache.org/comminity/...), i.e. from the Hugo bit, not
the manual
On Wed, May 5, 2021 at 11:43 PM Karen Lease <karenlease...@gmail.com> wrote:
>
> Hi Zoran (and all)
>
> In my previous mail I wrote:
>
> >>The ideal would perhaps be to include the CONTRIBUTING.md
> automatically in the website when it's built, but I haven't delved into
> the generator tools enough to know if that's doable. Also there would be
> some differences with links, since the ones in the repository version
> link with absolute URLs to the website.
>
> So I delved into it and found a working solution:
>
> In the MD file for the generated website
> (content/community/contributing.md), use a "shortcode" with the URL of
> the github CONTRIBUTING.md:
>
> {{< includefile
> file="https://api.github.com/repos/apache/camel/contents/CONTRIBUTING.md";
> >}}
>
> and define the shortcode includefile.html like this:
>
> {{ $response := getJSON (.Get "file") }}
> {{ $response.content | base64Decode | replaceRE
> "https://camel.apache.org/manual"; "/manual" | markdownify }}
>
> Does this seem like a workable plan?
This is a very interesting approach, and I do like it, we get to
maintain one copy, which I really like.
I wonder, though, we have several contribution documents, one per
subproject (see below). Perhaps it would make more sense to have
/CONTRIBUTING.md per repository and point to the website section with
a contribution guide for each subproject (and perhaps to the user
manual section, that seems broader).
This is what I found on the asf-site branch:
https://camel.apache.org/camel-quarkus/latest/contributor-guide/
https://camel.apache.org/manual/latest/contributing.html
https://camel.apache.org/camel-k/latest/contributing
https://camel.apache.org/camel-kafka-connector/[latest,0.4.x,0.7.x]/contributing.html
zoran
--
Zoran Regvart
