Hi Zoran,
Footnotes in a mail--I'm impressed! Thanks again for the excellent
mentoring.
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?
Linking from the website to the github CONTRIBUTING.md would require
using an absolute URL which doesn't feel right. If we keep the full
content in both places, we'll surely get them out of sync again.
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.
Since the changes are considerably larger than the initial idea of just
changing user-stories, I created a JIRA ticket:
https://issues.apache.org/jira/browse/CAMEL-16576; maybe you could
assign it to me? I noticed there are a few other website issues already
in JIRA, including CAMEL-14567 which seems to have been done.
Karen Lease
On 05/05/2021 11:43, Zoran Regvart wrote:
Hi Karen,
.....
Before creating the pull requests I have a few more questions.
1. There is no contributing.md file in the camel-website/community
content but there is both a CONTRIBUTING.md file at the root of the
camel repository as well as the file
docs/user-manual/modules/ROOT/pages/contributing.adoc. All the
contributing links in the website reference the HTML file generated from
the .adoc file. The camel/README.md file references CONTRIBUTING.md.
These files are similar but not identical and both have been modified
recently. Would it make sense to also move the contributing.md file to
the community content & reference that one from everywhere, including
the main README?
I think that makes sense, I'd keep the CONTRIBUTING.md file at the
root of repositories and just point to the website from there. The
reason behind having a CONTRIBUTING.md is that it became a sort of
convention for open source projects on GitHub, to a degree where it's
now part of the of the UI on GitHub[2]
--
Zoran Regvart
