You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2022/09/26 21:49:07 UTC
[GitHub] [nifi] turcsanyip commented on a diff in pull request #6430: NIFI-10523 - Udated Google Drive processor documentations.
turcsanyip commented on code in PR #6430:
URL: https://github.com/apache/nifi/pull/6430#discussion_r980521511
##########
nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/docs/org.apache.nifi.processors.gcp.drive.ListGoogleDrive/additionalDetails.html:
##########
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/html">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+<head>
+ <meta charset="utf-8"/>
+ <title>ListGoogleDrive</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/>
+</head>
+<body>
+
+<h1>Accessing Google Drive from NiFi</h1>
+
+<p>
+ This processor uses Google Cloud credentials for authentication to access Google Drive.
+ The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
+</p>
+<ol>
+ <li><b>Enable Google Drive API in Google Cloud</b> - Follow instructions at
+ https://developers.google.com/workspace/guides/enable-apis
Review Comment:
```suggestion
<a href="https://developers.google.com/workspace/guides/enable-apis">https://developers.google.com/workspace/guides/enable-apis</a>
```
##########
nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/docs/org.apache.nifi.processors.gcp.drive.ListGoogleDrive/additionalDetails.html:
##########
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/html">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+<head>
+ <meta charset="utf-8"/>
+ <title>ListGoogleDrive</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/>
+</head>
+<body>
+
+<h1>Accessing Google Drive from NiFi</h1>
+
+<p>
+ This processor uses Google Cloud credentials for authentication to access Google Drive.
+ The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
+</p>
+<ol>
+ <li><b>Enable Google Drive API in Google Cloud</b> - Follow instructions at
+ https://developers.google.com/workspace/guides/enable-apis
+ and search for 'Google Drive API'.
+ </li>
+ <li><b>Grant access to Google Drive folder</b> - In Google Cloud Console navigate to IAM & Admin -> Service
+ Accounts. Take a note of the email of the service account you are going to use.
+ Navigate to the folder to be listed in Google Drive. Right-click on the Folder -> Share. Enter the
+ service account email.
+ </li>
+ <li><b>Find Folder ID</b> - Enter the folder to be listed. The URL in your browser will include the ID at the end of
+ the URL.
Review Comment:
Maybe it is more straightforward where to enter:
```suggestion
<li><b>Find Folder ID</b> - Navigate to the folder to be listed in Google Drive and enter it. The URL in your browser will include the ID at the end of
the URL.
```
##########
nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/docs/org.apache.nifi.processors.gcp.drive.FetchGoogleDrive/additionalDetails.html:
##########
@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/html">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+<head>
+ <meta charset="utf-8"/>
+ <title>FetchGoogleDrive</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/>
+</head>
+<body>
+
+<h1>Accessing Google Drive from NiFi</h1>
+
+<p>
+ This processor uses Google Cloud credentials for authentication to access Google Drive.
+ The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
+</p>
+<ol>
+ <li><b>Enable Google Drive API in Google Cloud</b> - Follow instructions at
+ https://developers.google.com/workspace/guides/enable-apis
Review Comment:
```suggestion
<a href="https://developers.google.com/workspace/guides/enable-apis">https://developers.google.com/workspace/guides/enable-apis</a>
```
##########
nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/docs/org.apache.nifi.processors.gcp.drive.ListGoogleDrive/additionalDetails.html:
##########
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/html">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+<head>
+ <meta charset="utf-8"/>
+ <title>ListGoogleDrive</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/>
+</head>
+<body>
+
+<h1>Accessing Google Drive from NiFi</h1>
+
+<p>
+ This processor uses Google Cloud credentials for authentication to access Google Drive.
+ The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
+</p>
+<ol>
+ <li><b>Enable Google Drive API in Google Cloud</b> - Follow instructions at
+ https://developers.google.com/workspace/guides/enable-apis
+ and search for 'Google Drive API'.
+ </li>
+ <li><b>Grant access to Google Drive folder</b> - In Google Cloud Console navigate to IAM & Admin -> Service
+ Accounts. Take a note of the email of the service account you are going to use.
+ Navigate to the folder to be listed in Google Drive. Right-click on the Folder -> Share. Enter the
+ service account email.
+ </li>
+ <li><b>Find Folder ID</b> - Enter the folder to be listed. The URL in your browser will include the ID at the end of
+ the URL.
+ For example, if the URL were https://drive.google.com/drive/folders/1trTraPVCnX5_TNwO8d9P_bz278xWOmGm, the
+ Folder ID would be 1trTraPVCnX5_TNwO8d9P_bz278xWOmGm
Review Comment:
```suggestion
For example, if the URL were <code>https://drive.google.com/drive/folders/1trTraPVCnX5_TNwO8d9P_bz278xWOmGm</code>, the
Folder ID would be <code>1trTraPVCnX5_TNwO8d9P_bz278xWOmGm</code>
```
##########
nifi-nar-bundles/nifi-gcp-bundle/nifi-gcp-processors/src/main/resources/docs/org.apache.nifi.processors.gcp.drive.ListGoogleDrive/additionalDetails.html:
##########
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/html">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+<head>
+ <meta charset="utf-8"/>
+ <title>ListGoogleDrive</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/>
+</head>
+<body>
+
+<h1>Accessing Google Drive from NiFi</h1>
+
+<p>
+ This processor uses Google Cloud credentials for authentication to access Google Drive.
+ The following steps are required to prepare the Google Cloud and Google Drive accounts for the processors:
+</p>
+<ol>
+ <li><b>Enable Google Drive API in Google Cloud</b> - Follow instructions at
+ https://developers.google.com/workspace/guides/enable-apis
+ and search for 'Google Drive API'.
+ </li>
+ <li><b>Grant access to Google Drive folder</b> - In Google Cloud Console navigate to IAM & Admin -> Service
Review Comment:
I think it would make sense to add bullet points for the sub-steps (even if the given step contains only one point).
```
<li><b>Step N</b>
<ul>
<li>Sub-step 1</li>
<li>Sub-step 2</li>
<li>...</li>
</ul>
<li>
```
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org