Hi Antoine, Well done, btw, regarding some deadlinks, we could add checks in CI, here is a useful tool [1]. (Some links may cause 403 due to frequent visits.) but overall it is good, we have used it in SkyWalking for a long time[2].
In addition, we can need to make a plan to do the official website of the project, or hand it over to other volunteers. here is the list to check [3]. [1] https://github.com/tcort/markdown-link-check [2] https://github.com/apache/skywalking/blob/master/.github/workflows/dead-link-checker.yaml [3] https://incubator.apache.org/guides/sites.html On Wed, Dec 7, 2022 at 9:56 PM Antoine Drabble <antoine.drab...@gmail.com> wrote: > > Hello everyone, > > I have worked a bit on the documentation recently. > > In my opinion the first step to grow the community is to have a welcoming > and easy to read documentation. Whether it is to understand the code > structure, test out Baremaps or just understand what Baremaps is. > > In my opinion this is not clear at the moment. The scope of the project has > evolved from the initial goal which was to create vector tiles from OSM > data. > > Most of the links to Github are broken on the website. The example files > are no longer available on the main repository which break both > the IntelliJ configurations and the documentation. Finally, the main README > is also outdated. > > I have created 3 PRs, [1] to update the README, [2] to put back the > examples in the main repository and [3] to improve and add new sections to > the website. > > My work is probably not perfect as I had to edit a lot of files in a short > amount of time. I still have to test out all the guides as well. If anyone > is interested in reviewing my pull requests or testing the guides, please > do. > > Anyway we should probably merge this quickly, as many things in the current > documentation are outdated or broken. Then we can improve it iteratively. > > [1]https://github.com/apache/incubator-baremaps/pull/550 > [2]https://github.com/apache/incubator-baremaps/pull/551 > [3]https://github.com/apache/incubator-baremaps-site/pull/1 > > Best regards, > Antoine Drabble -- Best wishes！ CalvinKirs --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@baremaps.apache.org For additional commands, e-mail: dev-h...@baremaps.apache.org
