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

[GSK-2236] Fixing docs #1645

Merged
merged 9 commits into from
Nov 29, 2023
Merged

[GSK-2236] Fixing docs #1645

merged 9 commits into from
Nov 29, 2023

Conversation

rabah-khalek
Copy link
Contributor

@rabah-khalek rabah-khalek commented Nov 28, 2023

  • added text generations to the test catalog
  • standardizing index.rst for all main modules
  • 1:1 mapping between cells and TOC
  • introduced community cell

Copy link

linear bot commented Nov 28, 2023

Copy link
Member

@Hartorn Hartorn left a comment

Choose a reason for hiding this comment

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


checking consistency... /home/bazire/giskard/docs/community/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/giskard_hub/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/knowledge/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/open_source/index.rst: WARNING: document isn't included in any toctree

Could you fix these warnings also ?

docs/open_source/integrate_tests/index.md Show resolved Hide resolved
docs/integrations/index.rst Outdated Show resolved Hide resolved
Giskard Hub
===============

.. toctree::
Copy link
Member

Choose a reason for hiding this comment

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

Same as for integrations :

Should we use :hidden: here, and use cards instead ?

docs/community/index.rst Outdated Show resolved Hide resolved
docs/knowledge/index.rst Outdated Show resolved Hide resolved
docs/open_source/index.rst Outdated Show resolved Hide resolved
Copy link
Member

@Hartorn Hartorn left a comment

Choose a reason for hiding this comment

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

forgot to tick that

@rabah-khalek rabah-khalek requested a review from Hartorn November 29, 2023 10:43
@rabah-khalek
Copy link
Contributor Author

@Hartorn do you have an idea on how to silence these warnings in case I don't want to include some indexes in tocs (the reason being, they're alone in the category)

@Hartorn
Copy link
Member

Hartorn commented Nov 29, 2023

@Hartorn do you have an idea on how to silence these warnings in case I don't want to include some indexes in tocs (the reason being, they're alone in the category)

I would add them to an octree but with :hidden:

Also, if they are not in any octree, they are not accessible, except if you have some links in card. So i would create the hidden octree at the same place maybe

@Hartorn
Copy link
Member

Hartorn commented Nov 29, 2023

Another small issue : highlighted part is always in integrations
image
image

@Hartorn
Copy link
Member

Hartorn commented Nov 29, 2023

Also this is not coherent
image

@Hartorn
Copy link
Member

Hartorn commented Nov 29, 2023

Also this is not coherent image

fixed

@rabah-khalek rabah-khalek enabled auto-merge (squash) November 29, 2023 15:51
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@rabah-khalek rabah-khalek merged commit bc37b52 into main Nov 29, 2023
17 checks passed
@rabah-khalek rabah-khalek deleted the GSK-2236 branch November 29, 2023 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants