Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add docs for Google Drive and Onedrive datasources #144

Closed
osala-eng opened this issue Nov 9, 2023 · 0 comments · Fixed by #169
Closed

DOC: Add docs for Google Drive and Onedrive datasources #144

osala-eng opened this issue Nov 9, 2023 · 0 comments · Fixed by #169
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@osala-eng
Copy link
Contributor

osala-eng commented Nov 9, 2023

Documentation for Google Drive and OneDrive Datasources


Description

Currently, there is no documentation available for the Google Drive data source. As a part of PR: #135, a stub was created that currently links to Data Source: Google Drive. However, we need to flesh this out with detailed documentation that can help users to configure and use the Google Drive data source within docq.

Completion Criteria:

  1. Setup Instructions:

    • Step-by-step guide on setting up the Google Drive data source.
    • Include necessary prerequisites such as Google account requirements, API access, and any permissions needed.
  2. Configuration Details:

    • Detailed description of all configuration options available for the Google Drive data source.
    • Example configurations showing common setups.
  3. Troubleshooting:

    • Common issues and their resolutions.
    • Guidance on how to get help or report an issue with the data source.
  4. Limitations and Known Issues:

    • Document any known limitations or issues with the Google Drive data source.
  5. FAQs:

    • A section for frequently asked questions related to the Google Drive data source.
  6. Screenshots and Visual Aids:

    • Include relevant screenshots and diagrams that can assist in understanding the setup and usage.
  7. Review and Update Dependencies:

    • Verify that all links are working and point to the correct resources.
    • Update any dependencies or related documents that might be affected by the new documentation.

Additional Notes:

  • The documentation should be clear, concise, and easy to follow.
  • Technical accuracy must be maintained throughout the document.
  • Keep the tone consistent with the rest of the documentation on the site.
  • Use Markdown for formatting the document.

@osala-eng osala-eng self-assigned this Nov 9, 2023
@osala-eng osala-eng changed the title DOC: Add docs for Google Drive data source DOC: Add docs for Google Drive and Onedrive datasources Nov 29, 2023
@osala-eng osala-eng added the documentation Improvements or additions to documentation label Nov 29, 2023
@osala-eng osala-eng linked a pull request Dec 1, 2023 that will close this issue
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant