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

keywords proposal #675

Merged
merged 7 commits into from
Oct 24, 2023
Merged

keywords proposal #675

merged 7 commits into from
Oct 24, 2023

Conversation

jrobinAV
Copy link
Member

@jrobinAV jrobinAV commented Oct 19, 2023

I added a list of keywords for each kb_article. Here is the complete list:

gui, multi-page, vizelement, interactive, chart, navbar, layout, menu, input, text, button, state,
callback, on_change, table, part, expendable, scenario, task, datanode, configuration,
scenario_selector, dag, cycle, scope, job, job_execution, scenario_submission, standalone,
scenario_comparison, datanode_comparison, job_status, subscription, notify, markdown, storage_type,
file_selector, partials, dialog, pane, studio, dashboard, classification, optimization, ai, map,
notebook, deployment, stylekit, cloud

@FabienLelaquais @FlorianJacta @AlexandreSajus please review for each article the list of keywords used. Please do not hesitate to propose adding or removing keywords to some articles.

Once we agree on the keywords we can use some of them as a filter (not all of them 'cause we don't want to have to many filter values and we don't want a filter to display only one article).

@Jaufrey is it the right place to add keywords ? on the <li> tag?

docs/knowledge_base/index.md Outdated Show resolved Hide resolved
Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beside the obvious change on the attribute name...
I think this is far too detailed to be useful. And does not address the point: find what to use to do what. 'button' for example is not really helpful.
'dashboard' is good. People know what 'dashboard'-like applications are
'notebook' as well.

My proposal (note map- > maps):
gui, multi-page, layout, part, scenario, configuration, dag, cycle, scope, scenario_submission, standalone, scenario_comparison, subscription, storage_type, partials, studio, dashboard, classification, optimization, ai, maps, notebook, deployment, stylekit, cloud

If there are things that don't use any of those, we may want to extend it.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

Copy link
Contributor

@AlexandreSajus AlexandreSajus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me. To answer Fabien's comment: I get the point, but "button" can still be helpful if I look for examples of how to use a button. Both proposed solutions are fine with me.

@jrobinAV
Copy link
Member Author

jrobinAV commented Oct 23, 2023

  1. I removed the following keywords that I agree are either redundant or not necessary:
interactive, input, text, date, number, button, on_change, expendable, job_status, job_execution, scenario_selector, file_selector, file_download, dialog, pane

For instance, job_status and job_execution are already covered by job. I believe that's enough. If someone is interested in button or text, he/she surely don't want to read a tutorial, a demo or a tip. He/she wants to read the doc.

However, I kept the following keywords that were not in your proposal @FabienLelaquais:

vizelement, menu, chart, navbar, state, callback, table, task, datanode, job, notify, markdown

They may have some interest. Let's talk about it later.

@jrobinAV jrobinAV merged commit 1369efe into develop Oct 24, 2023
@jrobinAV
Copy link
Member Author

I am merging the PR now to unblock another PR on the topic. We can discuss and change the keywords later if needed.

@jrobinAV jrobinAV deleted the doc/keyword-proposal branch October 24, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants