GitHub READMEs for XWiki repositories

classic Classic list List threaded Threaded
11 messages Options
Reply | Threaded
Open this post in threaded view
|

GitHub READMEs for XWiki repositories

Ecaterina Moraru (Valica)
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
page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Thomas Mortagne
Administrator
Looks good.

The LICENSE is already discussed somewhere else.

On Tue, Nov 10, 2015 at 3:37 PM, Ecaterina Moraru (Valica)
<[hidden email]> 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
> page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs



--
Thomas Mortagne
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Eduard Moraru
+1

Thanks,
Eduard

On Tue, Nov 10, 2015 at 4:40 PM, Thomas Mortagne <[hidden email]>
wrote:

> Looks good.
>
> The LICENSE is already discussed somewhere else.
>
> On Tue, Nov 10, 2015 at 3:37 PM, Ecaterina Moraru (Valica)
> <[hidden email]> 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
> > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
>
>
>
> --
> Thomas Mortagne
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Jean SIMARD
In reply to this post by Ecaterina Moraru (Valica)
Very good idea, for sure we should do it and your proposition looks
already better that what I would have done ;-)

Thanks,

On 10/11/2015 15:37, Ecaterina Moraru (Valica) 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
> page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>

--
Jean Simard
[hidden email]
Research engineer at XWiki SAS
http://www.xwiki.com
Committer on the XWiki.org project
http://www.xwiki.org
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Guillaume "Louis-Marie" Delhumeau
Big +1

Guillaume

2015-11-10 15:50 GMT+01:00 Jean SIMARD <[hidden email]>:

> Very good idea, for sure we should do it and your proposition looks
> already better that what I would have done ;-)
>
> Thanks,
>
> On 10/11/2015 15:37, Ecaterina Moraru (Valica) 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
> > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
>
> --
> Jean Simard
> [hidden email]
> Research engineer at XWiki SAS
> http://www.xwiki.com
> Committer on the XWiki.org project
> http://www.xwiki.org
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>



--
Guillaume Delhumeau ([hidden email])
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Marius Dumitru Florea
In reply to this post by Ecaterina Moraru (Valica)
+1

Looks very nice.

Thanks,
Marius

On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
[hidden email]> 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
> page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Denis Gervalle-2
+1, go on, it’s nice to have.

On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
[hidden email]> wrote:

> +1
>
> Looks very nice.
>
> Thanks,
> Marius
>
> On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
> [hidden email]> 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
> > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>



--
Denis Gervalle
SOFTEC sa - CEO
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Ecaterina Moraru (Valica)
Hi,

Thanks for your support.

I've committed the new READMEs, see
https://github.com/xwiki/xwiki-enterprise/commit/8d389a6351b4cfd7fa8c0d5bfaf99f1aa8507443
https://github.com/xwiki/xwiki-platform/commit/3f2155bc37392cc83bae4893e57c538f2db655e6
https://github.com/xwiki/xwiki-rendering/commit/95632e17c7241d0644a41b6da6713b381cd31405
https://github.com/xwiki/xwiki-commons/commit/620769a0069be13a78b42de6c8d1cb71e25a82b3

Going to delete the gist.
Thanks,
Caty


On Wed, Nov 11, 2015 at 1:10 PM, Denis Gervalle <[hidden email]> wrote:

> +1, go on, it’s nice to have.
>
> On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
> [hidden email]> wrote:
>
> > +1
> >
> > Looks very nice.
> >
> > Thanks,
> > Marius
> >
> > On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
> > [hidden email]> 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
> > > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > > _______________________________________________
> > > devs mailing list
> > > [hidden email]
> > > http://lists.xwiki.org/mailman/listinfo/devs
> > >
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
>
>
>
> --
> Denis Gervalle
> SOFTEC sa - CEO
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

vmassol
Administrator
Thanks Caty! Now you’re responsible for maintaining the links ;)

-Vincent

On 16 Nov 2015 at 14:26:55, Ecaterina Moraru (Valica) ([hidden email]) wrote:

Hi,

Thanks for your support.

I've committed the new READMEs, see
https://github.com/xwiki/xwiki-enterprise/commit/8d389a6351b4cfd7fa8c0d5bfaf99f1aa8507443
https://github.com/xwiki/xwiki-platform/commit/3f2155bc37392cc83bae4893e57c538f2db655e6
https://github.com/xwiki/xwiki-rendering/commit/95632e17c7241d0644a41b6da6713b381cd31405
https://github.com/xwiki/xwiki-commons/commit/620769a0069be13a78b42de6c8d1cb71e25a82b3

Going to delete the gist.
Thanks,
Caty


On Wed, Nov 11, 2015 at 1:10 PM, Denis Gervalle <[hidden email]> wrote:

> +1, go on, it’s nice to have.
>
> On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
> [hidden email]> wrote:
>
> > +1
> >
> > Looks very nice.
> >
> > Thanks,
> > Marius
> >
> > On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
> > [hidden email]> 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
> > > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > > _______________________________________________
> > > devs mailing list
> > > [hidden email]
> > > http://lists.xwiki.org/mailman/listinfo/devs
> > >
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
>
>
>
> --
> Denis Gervalle
> SOFTEC sa - CEO
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

Ecaterina Moraru (Valica)
On Mon, Nov 16, 2015 at 3:45 PM, [hidden email] <[hidden email]>
wrote:

> Thanks Caty! Now you’re responsible for maintaining the links ;)
>

This is an Open Source community, each member is responsible and wants to
make the product and the community better, but sure, I will try to make
sure the links are up to date.

Thanks,
Caty



> -Vincent
>
> On 16 Nov 2015 at 14:26:55, Ecaterina Moraru (Valica) ([hidden email])
> wrote:
>
> Hi,
>
> Thanks for your support.
>
> I've committed the new READMEs, see
>
> https://github.com/xwiki/xwiki-enterprise/commit/8d389a6351b4cfd7fa8c0d5bfaf99f1aa8507443
>
> https://github.com/xwiki/xwiki-platform/commit/3f2155bc37392cc83bae4893e57c538f2db655e6
>
> https://github.com/xwiki/xwiki-rendering/commit/95632e17c7241d0644a41b6da6713b381cd31405
>
> https://github.com/xwiki/xwiki-commons/commit/620769a0069be13a78b42de6c8d1cb71e25a82b3
>
> Going to delete the gist.
> Thanks,
> Caty
>
>
> On Wed, Nov 11, 2015 at 1:10 PM, Denis Gervalle <[hidden email]> wrote:
>
> > +1, go on, it’s nice to have.
> >
> > On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
> > [hidden email]> wrote:
> >
> > > +1
> > >
> > > Looks very nice.
> > >
> > > Thanks,
> > > Marius
> > >
> > > On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
> > > [hidden email]> 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
> > > > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > > > _______________________________________________
> > > > devs mailing list
> > > > [hidden email]
> > > > http://lists.xwiki.org/mailman/listinfo/devs
> > > >
> > > _______________________________________________
> > > devs mailing list
> > > [hidden email]
> > > http://lists.xwiki.org/mailman/listinfo/devs
> > >
> >
> >
> >
> > --
> > Denis Gervalle
> > SOFTEC sa - CEO
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Reply | Threaded
Open this post in threaded view
|

Re: GitHub READMEs for XWiki repositories

vmassol
Administrator


On 16 Nov 2015 at 14:51:41, Ecaterina Moraru (Valica) ([hidden email](mailto:[hidden email])) wrote:

> On Mon, Nov 16, 2015 at 3:45 PM, [hidden email]  
> wrote:
>  
> > Thanks Caty! Now you’re responsible for maintaining the links ;)
> >
>  
> This is an Open Source community, each member is responsible and wants to
> make the product and the community better, but sure, I will try to make
> sure the links are up to date.

Yes I know. Thanks for what you did!

FTR if it were just me, I’d have put a single link to a single wiki page in each README (as we had already), like dev.xwiki.org and ensured that this page was a nice entry page for users to find anything they need to develop XWiki. That would have allowed to fully document everything in the wiki and benefit from xwiki’s rename system (auto update of backlinks).

But I’m happy that you went some extra miles to make it nicer for developers/contributors! :)

Let’s hope we don’t start adding more links (These links are far from complete and over time we may be tempted to add more for completeness ;)) because the more links the more we need to pay attention to not break them as we refactor wiki content.

Thanks
-Vincent


> Thanks,
> Caty
>  
>  
>  
> > -Vincent
> >
> > On 16 Nov 2015 at 14:26:55, Ecaterina Moraru (Valica) ([hidden email])
> > wrote:
> >
> > Hi,
> >
> > Thanks for your support.
> >
> > I've committed the new READMEs, see
> >
> > https://github.com/xwiki/xwiki-enterprise/commit/8d389a6351b4cfd7fa8c0d5bfaf99f1aa8507443
> >
> > https://github.com/xwiki/xwiki-platform/commit/3f2155bc37392cc83bae4893e57c538f2db655e6
> >
> > https://github.com/xwiki/xwiki-rendering/commit/95632e17c7241d0644a41b6da6713b381cd31405
> >
> > https://github.com/xwiki/xwiki-commons/commit/620769a0069be13a78b42de6c8d1cb71e25a82b3
> >
> > Going to delete the gist.
> > Thanks,
> > Caty
> >
> >
> > On Wed, Nov 11, 2015 at 1:10 PM, Denis Gervalle wrote:
> >
> > > +1, go on, it’s nice to have.
> > >
> > > On Tue, Nov 10, 2015 at 6:40 PM, Marius Dumitru Florea <
> > > [hidden email]> wrote:
> > >
> > > > +1
> > > >
> > > > Looks very nice.
> > > >
> > > > Thanks,
> > > > Marius
> > > >
> > > > On Tue, Nov 10, 2015 at 4:37 PM, Ecaterina Moraru (Valica) <
> > > > [hidden email]> 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
> > > > > page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
> > > > > _______________________________________________
> > > > > devs mailing list
> > > > > [hidden email]
> > > > > http://lists.xwiki.org/mailman/listinfo/devs
> > > > >
> > > > _______________________________________________
> > > > devs mailing list
> > > > [hidden email]
> > > > http://lists.xwiki.org/mailman/listinfo/devs
> > > >
> > >
> > >
> > >
> > > --
> > > Denis Gervalle
> > > SOFTEC sa - CEO
> > > _______________________________________________
> > > devs mailing list
> > > [hidden email]
> > > http://lists.xwiki.org/mailman/listinfo/devs
> > >
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> > _______________________________________________
> > devs mailing list
> > [hidden email]
> > http://lists.xwiki.org/mailman/listinfo/devs
> >
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs