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

[DOCUMENTATION] FINAL for v1.1.0 #1324

Merged
merged 22 commits into from
Oct 27, 2024
Merged

[DOCUMENTATION] FINAL for v1.1.0 #1324

merged 22 commits into from
Oct 27, 2024

Conversation

oualib
Copy link
Member

@oualib oualib commented Oct 25, 2024

[DOC PART2 - FINAL]

We then need to do the following tasks:

  • Remove the notebook archive, the script to generate the file due to the nested structure.
  • Check and revert to SPHINX_DIRECTORY
  • Remove the 1.0.x whatsnew.
  • Create the 1.1.0 whatsnew.
  • Compile the doc.
  • Test the doc.

TODO:

  • The links to the various elements of the user guide are inconsistent. The notebooks should follow a specific order. Additionally, some cell links are incorrect. For example, the LinearRegression link points to the UDF section. We need to double-check everything.
  • Some parts of the user guide, such as Joins and Data Ingestion, Model Management are missing.
  • Each user guide page (as well as Examples) should have "Next" and "Previous" buttons that link to the rest of the user guide.
  • The Examples section should also be included in the left-side menu of the website, positioned just before the API Reference.
  • Some customer testimonial logos are not the same size, and the display of the boxes may be buggy. We need to ensure that all boxes are uniform in size and that the images are consistent in their dimensions.
  • Writing a detailed "What's New" section that highlights all the new features (many for this major - and also pointing out all the deprecations).
  • Some elements are currently enclosed with a single backtick (`) or single quotation marks ('). They should be enclosed with double backticks (``) for consistency.
  • Some links are broken, such as those for decode(), discretize(), and PCA. These need to be fixed for proper navigation.
  • :py:mod:~verticapy.vDataFrames does not work. It needs a space before the "s".
  • Update Vertica Doc page. Some links to the recents docs are missing.
  • Some correlation matrices, such as the one for the Credit Card dataset, do not work properly. For large matrices, we should make them smaller and hide the digits. I believe we have options available to handle this.
  • Adding blocks and images for Examples.

[DOC PART2]

We then need to do the following tasks:
 - [ ] Remove the notebook archive, the script to generate the file due to the nested structure
 - [ ] Compile the doc
@oualib oualib added the Documentation Documentation issue or requirement. label Oct 25, 2024
@oualib oualib added this to the VerticaPy 1.1.0 milestone Oct 25, 2024
@oualib oualib requested a review from mail4umar October 25, 2024 07:02
@oualib oualib self-assigned this Oct 25, 2024
@oualib oualib changed the title [DOCUMENTATION] PART1 for v1.1.0 [DOCUMENTATION] FINAL for v1.1.0 Oct 25, 2024
@oualib oualib linked an issue Oct 25, 2024 that may be closed by this pull request
10 tasks
@oualib oualib merged commit 0140144 into master Oct 27, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation issue or requirement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation] Update before release of 1.1.0
2 participants