Skip to content

Add First Visit Guide (closes #1589)#1852

Merged
mlodic merged 11 commits intodevelopfrom
abheektripathy/firstvisitguide
Aug 28, 2023
Merged

Add First Visit Guide (closes #1589)#1852
mlodic merged 11 commits intodevelopfrom
abheektripathy/firstvisitguide

Conversation

@abheektripathy
Copy link
Member

@abheektripathy abheektripathy commented Aug 23, 2023 •
edited
Loading

closes #1589

Description

A tutorial guide to make first time visitors familiar to intelowl's frontend, by going through all major functionalities over various pages.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist

  • The pull request is for the branch develop
  • I have read and understood the rules about how to Contribute to this project
  • A new plugin (analyzer, connector, visualizer, playbook or ingestor) was added or changed, in which case:
    • Usage file was updated.
    • Advanced-Usage was updated (in case the plugin provides additional optional configuration).
    • If the plugin requires mocked testing, _monkeypatch() was used in its class to apply the necessary decorators.
    • If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive test_files.zip and you added the default tests for that mimetype in test_classes.py.
    • If you created a new analyzer and it is free (does not require API keys), please add it in the FREE_TO_USE_ANALYZERS playbook in playbook_config.json.
    • Check if it could make sense to add that analyzer/connector to other freely available playbooks.
    • I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
  • If external libraries/packages with restrictive licenses were used, they were added in the Legal Notice section.
  • Linters (Black, Flake, Isort) gave 0 errors. If you have correctly installed pre-commit, it does these checks and adjustments on your behalf.
  • I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.
  • If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check CONTRIBUTE.md).
  • If the GUI has been modified:
    • I have a provided a screenshot of the result in the PR.
    • I have created new frontend tests for the new component or updated existing ones.

Important Rules

  • If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers.
  • If your changes decrease the overall tests coverage (you will know after the Codecov CI job is done), you should add the required tests to fix the problem
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review. After being reviewed and received a "change request", you should explicitly ask for a review again once you have made the requested changes.

@abheektripathy abheektripathy linked an issue Aug 23, 2023 that may be closed by this pull request
[Frontend] guided tour/tutorial on first visit #1589
Closed
@codecov
Copy link

codecov bot commented Aug 23, 2023 •
edited
Loading

Codecov Report

Merging #1852 (7d405e1) into develop (aa8820f) will increase coverage by 9.48%.
Report is 1290 commits behind head on develop.
The diff coverage is 76.15%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1852      +/-   ##
===========================================
+ Coverage    66.75%   76.23%   +9.48%     
===========================================
  Files           95      381     +286     
  Lines         3706    12490    +8784     
  Branches       519     1316     +797     
===========================================
+ Hits          2474     9522    +7048     
- Misses         941     2427    +1486     
- Partials       291      541     +250
Files Changed Coverage Δ
...analyzers_manager/migrations/0004_datamigration.py 91.30% <ø> (ø)
...i_app/connectors_manager/migrations/0015_params.py 51.11% <ø> (ø)
...ager/migrations/0016_alter_connectorconfig_name.py 100.00% <ø> (ø)
...r/migrations/0017_alter_connectorconfig_options.py 100.00% <ø> (ø)
...ager/migrations/0018_alter_connectorconfig_name.py 100.00% <ø> (ø)
api_app/connectors_manager/models.py 95.65% <ø> (ø)
api_app/connectors_manager/serializers.py 100.00% <ø> (ø)
api_app/connectors_manager/urls.py 100.00% <ø> (ø)
api_app/connectors_manager/views.py 100.00% <ø> (ø)
api_app/decorators.py 78.94% <ø> (ø)
... and 231 more

... and 193 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 07428e1...7d405e1. Read the comment docs.

@abheektripathy
Copy link
Member Author

abheektripathy commented Aug 24, 2023

hey @mlodic added the guide, complying to Intelowl's design guidelines, here's a quick demo, let me know on any feedback or content changes required, or anymore steps to be added as well, will do.

guidedemo.1.mp4

@abheektripathy abheektripathy changed the title [WIP] Add First Visit Guide (closes #1589) Add First Visit Guide (closes #1589) Aug 24, 2023
@abheektripathy abheektripathy requested a review from mlodic August 24, 2023 22:23
@mlodic mlodic requested a review from drosetti August 25, 2023 07:15
drosetti
drosetti approved these changes Aug 25, 2023
View reviewed changes
Copy link
Contributor

@drosetti drosetti left a comment

Choose a reason for hiding this comment

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

I think you did a good job! Just two little changes:

1 - rename the state in the context component to guideState and setGuideState in this way we have a more specific name, "state" is too generic.
2 - The order of the var: instead of setGuideState, guideState use guideState, setGuideState

mlodic
mlodic approved these changes Aug 25, 2023
View reviewed changes
Copy link
Member

@mlodic mlodic left a comment

Choose a reason for hiding this comment

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

work is great! I'll just suggest some little adjustments for the final result.

@mlodic mlodic merged commit 67cd014 into develop Aug 28, 2023
@0ssigeno 0ssigeno deleted the abheektripathy/firstvisitguide branch May 7, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mlodic mlodic mlodic approved these changes

@drosetti drosetti drosetti approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Frontend] guided tour/tutorial on first visit

3 participants

@abheektripathy @mlodic @drosetti