You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@whimsical.apache.org by "John D. Ament" <jo...@apache.org> on 2017/10/13 20:50:28 UTC

Podling site checker questions

I noticed that https://whimsy.apache.org/pods/ was created but little info
going into it (e.g. I stumbled upon it, not that I saw it on a
general@incubator posting or anything).

I'm wondering where some of these checks come from?

For instance, we check that podling logos are uploaded to a directory.
This is the first I'm hearing of this.  AFAIK, the podlings don't upload
images here, instead when they graduate someone else does that.

Likewise, I see no podling has an events link.

Many podlings are linking to the wrong page for licenses.

Can someone point me to a reference for where these checks are defined,
from our guides, not from a code standpoint?

John

Re: Podling site checker questions

Posted by Shane Curcuru <as...@shanecurcuru.org>.
John D. Ament wrote on 10/13/17 5:40 PM: using gmail so >quoting off.
> On Oct 13, 2017 5:34 PM, "Shane Curcuru" <as...@shanecurcuru.org> wrote:
...snip...
> When I compared the podling checks to the TLP checks... I fear that
> podlings aren't too far off from TLPs (there's only 1 TLP check w/ 100% and
> that same check only has 1 failing podling).  So personally I would be
> against requiring it until all TLPs are passing.

Speaking just for myself, I expect podlings have a strong goal to pass
all checks before graduating.  But it's actually up to the IPMC and
board to vote on graduation.  In the short term, I don't expect any
failed graduation votes due to missing website checks, personally.


>> Can someone point me to a reference for where these checks are defined,
>> from our guides, not from a code standpoint?
> 
> https://github.com/apache/whimsy/blob/master/www/pods.cgi#L32
> 
> But that's the code, I'm looking for the relevant policies.  There's a link
> to policy on the page that explains 4 of the checks, but AFAIK the others
> are just not present anywhere.

The code has the URL of the policy, which is:
  https://www.apache.org/foundation/marks/pmcs#navigation

Perhaps I should change that to say "must" instead of "should" in each
individual <li> line.  Also, two policies are still being formally
written still, so that we do document what's expected:
> Notes:
> - VP, Legal is writing a policy URL requiring the Copyright line.
> - VP, Marketing is writing a policy URL requiring logo /img directory.

Also, the events policy is likely to be removed; See Rich's reply to the
"Justification for website checks" thread.  Obviously we should change
that check to either not display it or mark it's not required.

-- 

- Shane
  https://www.apache.org/foundation/marks/resources

Re: Podling site checker questions

Posted by "John D. Ament" <jo...@apache.org>.
On Oct 13, 2017 5:34 PM, "Shane Curcuru" <as...@shanecurcuru.org> wrote:

I thought you were on vacation or something! 8-)


Well i have a graduating podling who is concerned..



John D. Ament wrote on 10/13/17 4:50 PM:
> I noticed that https://whimsy.apache.org/pods/ was created but little info
> going into it (e.g. I stumbled upon it, not that I saw it on a
> general@incubator posting or anything).

Seems sebb created it by copying the normal site checker.  We should
really refactor the common methods out with pods.cgi and site.cgi, so
that as much of the logic of checking is consistent (even if we should
annotate some checks differently).

>
> I'm wondering where some of these checks come from?

Display code starts here:
  https://github.com/apache/whimsy/blob/master/www/pods.cgi#L17

Which mostly reads the results of automated checks stored by:
  https://github.com/apache/whimsy/blob/master/tools/site-scan.rb#L63

I've added a note to the top of the page noting podlings aren't expected
to pass until they're graduating, but clearly we should do a better job
explaining how the site checker works vis-a-vis the incubation process.


When I compared the podling checks to the TLP checks... I fear that
podlings aren't too far off from TLPs (there's only 1 TLP check w/ 100% and
that same check only has 1 failing podling).  So personally I would be
against requiring it until all TLPs are passing.



>
> For instance, we check that podling logos are uploaded to a directory.
> This is the first I'm hearing of this.  AFAIK, the podlings don't upload
> images here, instead when they graduate someone else does that.

True, Sally is working on the policy (this needs to be done, because
it's used on the a.o homepage) and someone in incubator-land should
figure out the right process to make it happen.

>
> Likewise, I see no podling has an events link.
>
> Many podlings are linking to the wrong page for licenses.
>
> Can someone point me to a reference for where these checks are defined,
> from our guides, not from a code standpoint?

https://github.com/apache/whimsy/blob/master/www/pods.cgi#L32



But that's the code, I'm looking for the relevant policies.  There's a link
to policy on the page that explains 4 of the checks, but AFAIK the others
are just not present anywhere.





Notes:
- VP, Legal is writing a policy URL requiring the Copyright line.
- VP, Marketing is writing a policy URL requiring logo /img directory.

>
> John
>


--

- Shane
  https://www.apache.org/foundation/marks/resources

Re: Podling site checker questions

Posted by Shane Curcuru <as...@shanecurcuru.org>.
I thought you were on vacation or something! 8-)

John D. Ament wrote on 10/13/17 4:50 PM:
> I noticed that https://whimsy.apache.org/pods/ was created but little info
> going into it (e.g. I stumbled upon it, not that I saw it on a
> general@incubator posting or anything).

Seems sebb created it by copying the normal site checker.  We should
really refactor the common methods out with pods.cgi and site.cgi, so
that as much of the logic of checking is consistent (even if we should
annotate some checks differently).

> 
> I'm wondering where some of these checks come from?

Display code starts here:
  https://github.com/apache/whimsy/blob/master/www/pods.cgi#L17

Which mostly reads the results of automated checks stored by:
  https://github.com/apache/whimsy/blob/master/tools/site-scan.rb#L63

I've added a note to the top of the page noting podlings aren't expected
to pass until they're graduating, but clearly we should do a better job
explaining how the site checker works vis-a-vis the incubation process.

> 
> For instance, we check that podling logos are uploaded to a directory.
> This is the first I'm hearing of this.  AFAIK, the podlings don't upload
> images here, instead when they graduate someone else does that.

True, Sally is working on the policy (this needs to be done, because
it's used on the a.o homepage) and someone in incubator-land should
figure out the right process to make it happen.

> 
> Likewise, I see no podling has an events link.
> 
> Many podlings are linking to the wrong page for licenses.
> 
> Can someone point me to a reference for where these checks are defined,
> from our guides, not from a code standpoint?

https://github.com/apache/whimsy/blob/master/www/pods.cgi#L32

Notes:
- VP, Legal is writing a policy URL requiring the Copyright line.
- VP, Marketing is writing a policy URL requiring logo /img directory.

> 
> John
> 


-- 

- Shane
  https://www.apache.org/foundation/marks/resources