Hi, I'd like to cite a couple of example usage of a 'standard' ASF Compliant website + readthedocs usage
Here are two examples:- libcloud.apache.org cloudstack.apache.org Both of those projects have content , built however they want, and the code for the 'website' part can indeed be hosted on Github, with for example a .asf.yaml file in place which would then allow the site to be built and deployed upon commit. (building could trigger a Jenkins build for example, a Github Action, or other methods) The content of the above websites include the project logo, project description, links to required other areas of the ASF such as The Apache License, Thanks page, how to donate, etc. They also include project information, such as where to find the mailing lists, how to sign up, where to read the list archives, who the project committers/pmc are, a page describing the latest releases , where to download them from and a cgi pointing folks to their nearest download mirror. Plus more stuff. What they, and all other project websites have in common is, they are deployed and housed on ASF controlled hardware, that Infra maintains and can therefore control reliability and uptime etc. We can not rely on 3rd party hosting for the 'main' project website. As for the 'readthedocs' component of the above two sites, they link 'Documentation' to readthedocs and both have also CNAMES in place such as 'docs.libcloud.apache.org' points to 'https://libcloud.readthedocs.io/en/stable/' , whilst 'docs.cloudstack.apache.org' redirects to readthedocs whilst retaining that url. How they generate and upload those docs to readthedocs.org is a question to ask those communities, I know of other ASF projects that use Github and/or Jenkins to build those docs and use a readthedocs token (we'd place on a github repo or jenkins for you) to upload. Github Actions is also a possibility. I have looked over the thrift.apache.org website, and there is much that can remain, we just need to get you off the CMS and onto another method for you publishing that to thrift.apache.org, various methods are supported and this is what we should thrash out on the Infra ticket. Some of this content on thrift.apache.org could be transferred to generated docs for readthedocs.org. We would also be happy to create a CMAME of docs.thrift.apache.org to point there, and you can use a Documentation page/link on the main website to point users there for the bulk of the Thrift documentation. Hope that all makes sense. Infra are here to help get you off of the CMS is our main concern at this time. Gavin (ASF Infra Team) On 2020/10/28 17:50:24, "Duru Can Celasun" <[email protected]> wrote: > Apologies, I thought I was replying to Andrew and I only just now realize it > was Christopher. My point stands though, if there is an easier/preferred way > to do this just let me know and we'll do that. > > On Wed, 28 Oct 2020, at 17:46, Duru Can Celasun wrote: > > Andrew, > > > > I think there has been some misunderstanding. Comments below. > > > > On Wed, 28 Oct 2020, at 16:31, Christopher wrote: > > > Can, > > > > > > The official site for Apache Thrift is located at thrift.apache.org > > > It is the sources for that site that needs to move away from CMS. It > > > is not sufficient to create a new site located elsewhere to address > > > the CMS issue. > > > > > > While this "readthedocs" site looks good, it is missing some key > > > things required for ASF projects... like the mandatory foundation > > > links and copyright footer information (see > > > https://whimsy.apache.org/site/project/thrift). > > > > Thanks, I wasn't aware but I'm happy to add all of this. > > > > > I also think it > > > doesn't look quite as good as the current site's layout, but that's > > > probably personal taste. > > > > I'm not a designer and I know nothing about frontend development. The > > current "look" of the site is simply the default provided by RTD. I > > have neither the skills nor the interest in a new design and nobody > > else ever volunteered. > > > > It might also be a problem that it has ads on > > > it at readthedocs.io, though I think that might be possible to address > > > if it is generated locally and not hosted on readthedocs.io. > > > > That was always the intention, as stated in the original Jira issue > > [1]. In fact, I've provided build instructions that can be used by > > INFRA. > > > > I wasn't aware of any ads, but then again that website is simply a > > proof of concept on my personal RTD account. > > > > > > > > So, where it is currently hosted at readthedocs.io, it is not a > > > suitable alternative to the CMS hosted thrift.apache.org site... which > > > still needs to be addressed. > > > > See above. > > > > > > > > In order to replace the CMS site with this new site as the new > > > thrift.apache.org, the issues I mentioned would need to be fixed, and > > > then you'd have to generate the site locally and publish it in an ASF > > > git repository, and configure it to publish to thrift.apache.org using > > > an '.asf.yaml' configuration file (see > > > https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-WebSiteDeploymentServiceforGitRepositories). > > > > Thanks for the link. I'm not familiar with this but if INFRA could > > create a thrift-website repo for us on Github I'd be happy to take a > > look. > > > > > > > > However, I think it would be much easier to set up a simple > > > jekyll-based site using the existing CMS content as a starting point. > > > It's really not hard to do that at all. I could help with the effort, > > > but it's harder to explain than it is to do. I've already been helping > > > maintain both Accumulo and Fluo's websites in this same way, as a > > > committer on those projects, so I know it's super easy to maintain > > > once it's set up, and the set up isn't hard at all. I'm not a Thrift > > > committer, so I can't do most of the steps myself for Thrift, but I > > > can try to walk a committer through the process. > > > > > > I'm more than happy to do it your way, especially if you think it'd be > > easier. My one concern is that the current CMS content isn't exactly > > great and my RTD version has improvements, but we can sort that later. > > How should we proceed? > > > > > > > > Christopher > > > > [1] > > https://issues.apache.org/jira/browse/THRIFT-4710?focusedCommentId=16972218&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16972218 > > > > > > > > > > On Wed, Oct 28, 2020 at 8:43 AM Duru Can Celasun <[email protected]> > > > wrote: > > > > > > > > Hi Andrew, > > > > > > > > The site on ReadTheDocs [1] isn't just documentation, it's the full > > > > website including downloads [2] so I'm not sure if any other static > > > > landing page is necessary. > > > > > > > > If you can clarify that first I'll go ahead and open an INFRA ticket. > > > > > > > > Can > > > > > > > > [1] https://thrift-fork.readthedocs.io/en/docs/index.html > > > > [2] https://thrift-fork.readthedocs.io/en/docs/download.html > > > > > > > > On Wed, 28 Oct 2020, at 12:35, Andrew Wetmore wrote: > > > > > Hi, Can: > > > > > > > > > > I spoke with Gavin MacDonald on our team, and he said the Thrift > > > > > project > > > > > will still need at least a basic static landing page at thrift.a.o. > > > > > If I > > > > > understand correctly, you can redirect traffic from there to what you > > > > > have > > > > > set up in ReadTheDocs. The landing page should also have information > > > > > on > > > > > links for downloading software releases. > > > > > > > > > > Gavin requested that you open a Jira ticket directed at Infra to > > > > > cover the > > > > > project's migration so we can keep track of what we need to do to > > > > > provide a > > > > > smooth transition for the project. > > > > > > > > > > Andrew > > > > > > > > > > On Sat, Oct 3, 2020 at 1:10 PM Duru Can Celasun <[email protected]> wrote: > > > > > > > > > > > Hi Andrew, > > > > > > > > > > > > Any news on this? How should we proceed? > > > > > > > > > > > > Cheers, > > > > > > Can > > > > > > > > > > > > On Wed, 26 Aug 2020, at 16:38, Duru Can Celasun wrote: > > > > > > > Hi Andrew, > > > > > > > > > > > > > > Sorry for the late response. Last year I started working on a > > > > > > > migration > > > > > > > from Apache CMS to "read the docs" [1] but I never got a chance to > > > > > > > finish it. > > > > > > > > > > > > > > It's mostly complete, but we could definitely use some INFRA help > > > > > > > to > > > > > > > get it over the finish line. > > > > > > > > > > > > > > Would it be possible to have a thrift-website repo on Github and > > > > > > > have > > > > > > > it deployed via Travis? > > > > > > > > > > > > > > The linked issue has build instructions but I'd be happy to make > > > > > > > changes if needed. > > > > > > > > > > > > > > Please let me how you'd like to proceed. > > > > > > > > > > > > > > Cheers, > > > > > > > Can > > > > > > > > > > > > > > [1] > > > > > > > > > > > > > https://issues.apache.org/jira/browse/THRIFT-4710?focusedCommentId=16972218&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16972218 > > > > > > > > > > > > > > On Mon, 24 Aug 2020, at 14:06, Andrew Wetmore wrote: > > > > > > > > Hi: > > > > > > > > > > > > > > > > I wrote to you two weeks ago about your project website, but > > > > > > > > have not > > > > > > seen > > > > > > > > a response. Whom should I contact directly? I am trying to see > > > > > > > > whether > > > > > > your > > > > > > > > project still uses the Apache CMS and, if so, what your plans > > > > > > > > are to > > > > > > > > migrate off it. > > > > > > > > > > > > > > > > Thanks in advance for your help. > > > > > > > > > > > > > > > > Andrew > > > > > > > > > > > > > > > > On Fri, Aug 7, 2020 at 10:06 AM Andrew Wetmore > > > > > > > > <[email protected]> > > > > > > wrote: > > > > > > > > > > > > > > > > > Hi: > > > > > > > > > > > > > > > > > > I am part of the Infrastructure team, and am writing to ask > > > > > > > > > whether > > > > > > your > > > > > > > > > project is still using the Apache CMS for your project > > > > > > > > > website. As > > > > > > you > > > > > > > > > know, the CMS is reaching end-of-life, and we need projects > > > > > > > > > to move > > > > > > their > > > > > > > > > websites onto a different option within the next few weeks. > > > > > > > > > > > > > > > > > > There are several alternatives available, including those > > > > > > > > > listed on > > > > > > this > > > > > > > > > page [1] on managing project websites. Infra is assembling a > > > > > > > > > Wiki > > > > > > page [2] > > > > > > > > > on migrating a website from the CMS, and is looking forward to > > > > > > helping > > > > > > > > > projects with this transition. > > > > > > > > > > > > > > > > > > Please let me know whether your site is still on the Apache > > > > > > > > > CMS and, > > > > > > if > > > > > > > > > so, who will be the project point-of-contact with Infra for > > > > > > > > > the > > > > > > migration. > > > > > > > > > > > > > > > > > > Thank you! > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > [1] https://infra.apache.org/project-site.html > > > > > > > > > > > > > > > > > > [2] > > > > > > > > > > > > > > > https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS > > > > > > > > > > > > > > > > > > > > > > > > > > > -- > > > > > > > > > Andrew Wetmore > > > > > > > > > Technical Writer-Editor > > > > > > > > > Infra > > > > > > > > > *Apache Software Foundation* > > > > > > > > > [email protected] > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > > > https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail> > > > > > > Virus-free. > > > > > > > > > www.avast.com > > > > > > > > > < > > > > > > https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail > > > > > > > > > > > > > > > > <#m_3918189248972690169_DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -- > > > > > > > > Andrew Wetmore > > > > > > > > Technical Writer-Editor > > > > > > > > Infra > > > > > > > > *Apache Software Foundation* > > > > > > > > [email protected] > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -- > > > > > Andrew Wetmore > > > > > Technical Writer-Editor > > > > > Infra > > > > > *Apache Software Foundation* > > > > > [email protected] > > > > > > > > > > >
