The website consists of two parts which are maintained in two separate respositories:
1) The project website about features, community, etc. 2) The documentation of the project We have the separation because we want to be able to update source and documentation in one repository to avoid that the documentation gets out of sync. The documentation is built every night and hosted at ci.apache.org to achieve that. IMO, this separation makes sense, because the project website is not changed very often whereas the documentation should be touched whenever the API or behavior is changed. I think it is very important to have documentation in sync with the code. In fact, I believe both parts of the website should not be related to each other, so they shouldn't be a way to have both parts getting out-of-sync, except for layout / design which is nice to have but not crucial. We might even think about changing the color-scheme of the documentation to make the difference more clear. 2015-10-26 10:12 GMT+01:00 Matthias J. Sax <mj...@apache.org>: > Hi, > > I am not sure, but I guess there is something wrong on the web page. If > you click on "Overview" in the menu bar at the start page > (https://flink.apache.org/), it links to > https://flink.apache.org/index.html > > This seems to be wrong to me. I guess it should link to > https://ci.apache.org/projects/flink/flink-docs-release-0.9/index.html > ("Overview" links to this page if you first go to "Quickstart -> Setup" > for example) > > While this can be easily fixed, the more fundamental problem here seems > to be the "duality" of the web page. We have the flink-web.git > repository and the "doc" folder in flink.git. Thus, it can easily happen > that both parts get out-of-sync. > > Both parts are hosted on different URLs, too (https://flink.apache.org > and https://ci.apache.org/projects/flink). I personally think, this is > not too nice, and if I want to change something, it is always confusion > which part of the web page originates from which git repo. Furthermore, > the menu bars of both pages are not 100% identical. (Right now, the menu > bars need to be kept in sync manually.) > > Additionally, a few pages have no content. For example: > > https://ci.apache.org/projects/flink/flink-docs-release-0.9/internals/how_to_contribute.html > > > "The How to Contribute guide is located on the project website." > > Why not link to the correct page in the first place? > > > What is the reason for this duality? It there a good way to avoid (some > automatic checks?) that both parts go out-of-sync? Should be try to > "merge" both parts together? I am just raising "random" questions about > it. I guess there is a good reason for the current situation that I am > not aware of. From my point of view, there are two ways to go. Either, > merge both parts completely, or separate them more strictly (such that > it gets clear that it is actually two web pages and not one). > > > -Matthias > >
