search

eclipse-cbi / p2repo-aggregator

Eclipse Public License 2.0
0 stars 2 forks source link

Readme / documentation page #1

Open jmini opened 3 years ago

jmini commented 3 years ago

Since this is well supported by GitHub, I think it would be useful to have a README in this repository.

In addition I have the feeling the content of the wiki page https://wiki.eclipse.org/CBI/aggregator should be migrated to this repository. Probably under a new folder docs/ The page as docs/index.adoc (or markdown if you prefer) and all the images next to the page in the same folder.

If you are interested, let me know, I can contribute it.

jmini commented 3 years ago

At least I updated the wiki page to point to this repository: https://wiki.eclipse.org/index.php?title=CBI%2Faggregator&type=revision&diff=444024&oldid=443331

mbarbero commented 3 years ago

please, feel free to create a PR with the proposed changes; we love those 🤩

merks commented 2 years ago

I added a readme now. Migrating documentation will be more work for the future. Probably using this repository's wiki would be an okay place for the documentation as well...

jmini commented 2 years ago

I don't know if there is an official guideline about repository's wiki, but for me having documentation pages in the main repository is better.

With the wiki feature (which corresponds to a second git-repository for the same GitHub project) you do not have the possibility to work with pull requests. Also I am not sure how the write-permission is handled. If I remember well, it is quite limited and the fact that you can't do pull-request for the wiki repository prevents from having contribution from the outside.