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

Substrait FAQ Page #409

Open
vibhatha opened this issue Dec 26, 2022 · 3 comments
Open

Substrait FAQ Page #409

vibhatha opened this issue Dec 26, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted No one is currently implementing but it seems like a good idea

Comments

@vibhatha
Copy link
Contributor

There are frequently asked questions which can be included in a separate page on the main website. I propose, it is better to group such a set of questions which have already been asked and create this page.

@vibhatha vibhatha self-assigned this Dec 26, 2022
@vibhatha vibhatha added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 26, 2022
@vibhatha
Copy link
Contributor Author

cc @westonpace @jacques-n @ianmcook

@westonpace
Copy link
Member

westonpace commented Dec 26, 2022

It sounds like you are proposing that the three questions on the main page be moved to a dedicated page? I think that would be ok. However, the navigation list (home, spec, types, expressions, ...) is starting to get quite long, and adding an FAQ item is just going to make it longer. At one point I think @jacques-n recommended changing this to a two level list. For example, maybe something like:

  • Home
    • Introduction
    • FAQ
  • Spec
    • Introduction
    • Types
    • Expressions
    • Relations
    • Serialization
    • Extensions
  • Community
    • How to get Involved
    • Governance

Are you also suggesting we add more questions?

@vibhatha
Copy link
Contributor Author

FAQ could be a nice thing to go along side the introduction or community. Since FAQs are rather created by the community involvement than by maintainers themselves.

Also FAQ is something that could evolve with time. I would say it needs to be updated quarterly or annually or whenever we see the same question being asked multiple times in mailing list, etc. This last bit is just a suggestion. What you suggested is more than sufficient for the current stage.

@westonpace westonpace added the help wanted No one is currently implementing but it seems like a good idea label Mar 8, 2023
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 enhancement New feature or request help wanted No one is currently implementing but it seems like a good idea
Projects
None yet
Development

No branches or pull requests

2 participants