Thanks Caty! Now you’re responsible for maintaining the links ;)
-Vincent
On 16 Nov 2015 at 14:26:55, Ecaterina Moraru (Valica) (valicac(a)gmail.com) wrote:
Hi,
Thanks for your support.
I've committed the new READMEs, see
Going to delete the gist.
Thanks,
Caty
On Wed, Nov 11, 2015 at 1:10 PM, Denis Gervalle <dgl(a)softec.lu> wrote:
+1, go on, it’s nice to have.
On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
mariusdumitru.florea(a)xwiki.com> wrote:
+1
Looks very nice.
Thanks,
Marius
On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
valicac(a)gmail.com> wrote:
> Hi,
>
> Currently we don't provide any README files for the repositories found
on
>
https://github.com/xwiki
>
> There are several remarks about this fact:
> - README is promoted by GitHub as the way to summarize your project.
That
green
button "Add a README" won't disappear unless we create a file :)
- All the other major organizations provide READMEs for their
repositories,
even if they have dedicated websites (a.k.a the
README is not the only
way
to document your project).
I think we should provide a README that contains just:
- Summary for the repo
- Links to the
xwiki.org wiki about that particular repo
-- the links should be general and easy to maintain
-- they should facilitate access to devs for the most useful pages on
xwiki.org, promoting development and contributions.
I've created these proposals:
- Enterprise
https://gist.github.com/evalica/b439c6dc98ca109e1f5b
- Platform
https://gist.github.com/evalica/6431b99514d59bb7b66f
- Rendering
https://gist.github.com/evalica/79298c6830480eff321d
- Commons
https://gist.github.com/evalica/2affcfff5a4a40b418aa
The custom parts for each repository are Summary, Documentation,
Download.
> The generic parts are Release Notes, Tools, Community.
>
> Let me know what you think.
>
> Thanks,
> Caty
>
> P.S. For the LICENSE file we could just provide a link to the
xwiki.org
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Denis Gervalle
SOFTEC sa - CEO
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________
devs mailing list
devs(a)xwiki.org