Skip to content

Create documentation page with links to external resources #1350

Open
wants to merge 5 commits into
base: docs-prototype
Choose a base branch
from

Conversation

Mr-Geekman
Copy link
Contributor

@Mr-Geekman Mr-Geekman commented Aug 8, 2023

Before submitting (must do checklist)

  • Did you read the contribution guide?
  • Did you update the docs? We use Numpy format for all the methods and classes.
  • Did you write any new necessary tests?
  • Did you update the CHANGELOG?

Proposed Changes

Look #1348.

Closing issues

Closes #1348.

@Mr-Geekman Mr-Geekman self-assigned this Aug 8, 2023
@github-actions
Copy link

github-actions bot commented Aug 8, 2023

@github-actions github-actions bot temporarily deployed to pull request August 8, 2023 06:48 Inactive
@codecov-commenter
Copy link

codecov-commenter commented Aug 8, 2023

Codecov Report

❗ No coverage uploaded for pull request base (docs-prototype@8670ae2). Click here to learn what that means.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@               Coverage Diff                @@
##             docs-prototype   #1350   +/-   ##
================================================
  Coverage                  ?   6.60%           
================================================
  Files                     ?     204           
  Lines                     ?   12637           
  Branches                  ?       0           
================================================
  Hits                      ?     835           
  Misses                    ?   11802           
  Partials                  ?       0           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@@ -19,6 +19,7 @@ Contents
:maxdepth: 1
:titlesonly:

user_guide
installation
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add external resources here?

At the moment it's not easy to find external resources page

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think that this page is that necessary to be in the header.

Copy link
Contributor

Choose a reason for hiding this comment

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

How should user find this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

He opens "User Guide" section and it will be a page inside this section.

@@ -201,32 +201,34 @@ To ask the questions or discuss the library you can join our [telegram chat](htt

## Resources

- [Forecasting with ETNA: Fast and Furious](https://medium.com/its-tinkoff/forecasting-with-etna-fast-and-furious-1b58e1453809) on Medium
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the logic behind such ordering?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried to order this entries by chronological order.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you think about this section in README? Should we keep it?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that the importance and usefulness is better for ordering. As a rule people click only first links

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you have any particular order in mind? I don't really know how to order them by importance. We could order them by groups. First there are medium pages in chronological order. Then kaggle pages in chronological order, in the end everything else.

Copy link
Contributor

Choose a reason for hiding this comment

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

We should add resources with 2.0 api on top at least, I think.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants