leahecole commented on pull request #13767:
URL: https://github.com/apache/airflow/pull/13767#issuecomment-765732982


   Hey friends! @potiuk asked me to look at 
[http://gabby-cough.surge.sh/](http://gabby-cough.surge.sh/) and to share some 
thoughts. With the sheer volume of files in this PR, I had trouble figuring out 
what source files were mapping to the site, so I'm sharing my thoughts in this 
comment in bullet point form. 
   
   - Right now, the "Content" section at the top is a duplication of what's on 
the left sidebar. I'd vote for its removal, especially because I feel like 
Installation and requirements should be at the very top. I like what's in the 
sidebar though.
   - Are there any prerequisites a user must fulfill before installing this 
package? 
   - There may be general ones that we cover on a page for all provider 
packages, but is there anything that a user has to do before installing the 
google ones? 
   - In the "Provider package" section it says "This is a provider package for 
`google`" provider - there should be a "the" before the word Google. 
Additionally, what do y'all think about linking to the source code on the words 
"`google` provider"? 
   - How are we linking to other guides? (Thinking that things like this 
https://github.com/apache/airflow/pull/9798 belong linked)
   - Looking at one of the operators in particular, and I love the prerequisite 
tasks (Oh, are these perhaps the guides that are embedded in this?)
   - This might be out of scope for this change, but in general, when you go to 
Operators, then click on an operator and hit "view source" the source code is 
embedded in the page. Should we instead consider redirecting folks to GitHub, 
or adding a "View on GitHub" option? (Often I want to look at the code history, 
but I recognize I'm just one data point)
   
![4qaKTNCeTSRHBW3](https://user-images.githubusercontent.com/6719667/105557969-5a1a0e80-5cc2-11eb-99eb-40f7d25e3d96.png)
   
   - I really love the detailed changelog and that it's there. Not sure that 
the links are rendering correctly though. What is the difference between the 
changelog and the detailed changelog though? Is the changelog breaking changes 
only? Or just major ones? As an end user, I dont' understand why both are there.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to