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.

Sign up for GitHub

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

Jump to bottom

Update pytorch.org/ignite site and reference pytorch-ignite.ai #2325

Closed
vfdev-5 opened this issue Nov 13, 2021 · 9 comments · Fixed by #2432
Closed

Update pytorch.org/ignite site and reference pytorch-ignite.ai #2325

vfdev-5 opened this issue Nov 13, 2021 · 9 comments · Fixed by #2432
Assignees
@vfdev-5 @sdesrozis @trsvchn
Labels
docs

Comments

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Nov 13, 2021 •
edited
Loading

📚 Documentation

Our project new website is online and available. We need to update pytorch.org/ignite to reflect only API and provide links to pytorch-ignite.ai as source for examples/tutorials/how-to guides etc.

Redirections:

Quickstart -> https://pytorch-ignite.ai/tutorials/beginner/01-getting-started/
FAQ -> https://pytorch-ignite.ai/how-to-guides/
Concepts -> TBD
Examples -> TBD
Github -> Github (no change)
About us -> https://pytorch-ignite.ai/about/community/

Index page (https://pytorch.org/ignite/)

Remove almost all the content and add the logo and the link to https://pytorch-ignite.ai. Like below (but better aligned):

https://pytorch-ignite.ai

Add another explicit link to https://pytorch-ignite.ai from the header ?

The idea is to have something like:

Quickstart    Concepts    Examples     FAQ     GitHub     About us    https://pytorch-ignite.ai

Any thoughts ?
@vfdev-5 vfdev-5 added the docs label Nov 13, 2021
@hs094
Copy link

hs094 commented Dec 10, 2021

Is this issue open to be taken up?

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Dec 10, 2021 •
edited
Loading

Hi @iamhardikat11 , this issue is a bit critical for the project, but yes, you can help with a part of it, for example, replacing the links for: about us, FAQ, Quickstart (as suggested in the description) and remove those .rst files.
What do you think ?

@hs094
Copy link

hs094 commented Dec 11, 2021

Yup, I can work on that. I will Submit my PR By today Night.

@Priyansi Priyansi mentioned this issue Jan 4, 2022
Open
3 tasks
@Moh-Yakoub
Copy link
Contributor

Hi @iamhardikat11 , this issue is a bit critical for the project, but yes, you can help with a part of it, for example, replacing the links for: about us, FAQ, Quickstart (as suggested in the description) and remove those .rst files. What do you think ?

@vfdev-5 Any other parts that I can help with at the moment?

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Jan 17, 2022

@Moh-Yakoub yes, you can help. Nothing is done at the moment. You can submit a PR with docs updates for the redirections (see the description). What do you think ?

This was referenced Jan 17, 2022
Closed
Closed
@Moh-Yakoub
Copy link
Contributor

@Moh-Yakoub yes, you can help. Nothing is done at the moment. You can submit a PR with docs updates for the redirections (see the description). What do you think ?

Great, I will start doing that. Thanks a lot!

Moh-Yakoub added a commit to Moh-Yakoub/ignite that referenced this issue Jan 18, 2022
@Moh-Yakoub
Update pytorch.org/ignite site and reference pytorch-ignite.ai pytor…
4d105e7 
…ch#2325
@Moh-Yakoub Moh-Yakoub mentioned this issue Jan 18, 2022
Merged
3 tasks
vfdev-5 added a commit that referenced this issue Jan 18, 2022
@Moh-Yakoub @vfdev-5
Update pytorch.org/ignite site and reference pytorch-ignite.ai #2325 (…
336b0c3 
…#2431)

Co-authored-by: vfdev <vfdev.5@gmail.com>
@Moh-Yakoub
Copy link
Contributor

@vfdev-5 I just checked the updated task description.

I agree with your suggested approach, but maybe add some description to explain the missing documentation i.e. something like "All our documentation moved to https://pytorch-ignite.ai." or something similar.

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Jan 18, 2022

Yes, I agree, thanks for the suggestion!

@Moh-Yakoub
Copy link
Contributor

Yes, I agree, thanks for the suggestion!

I will prepare a prototype and draft PR and we can iterate over it till we reach a mature design for the page. Thanks for your input!

@Moh-Yakoub Moh-Yakoub mentioned this issue Jan 18, 2022
Merged
3 tasks
vfdev-5 added a commit that referenced this issue Dec 26, 2022
@Moh-Yakoub @vfdev-5
[#2325] Remove old docs related at https://pytorch.org/ignite/ (#2432)
00e7ea0 
* remove all old docs

* revert some used items

* More updates according to the review

Co-authored-by: vfdev-5 <vfdev.5@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vfdev-5 vfdev-5

@sdesrozis sdesrozis

@trsvchn trsvchn

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[#2325] Remove old docs related at https://pytorch.org/ignite/ Moh-Yakoub/ignite
5 participants
@Moh-Yakoub @vfdev-5 @sdesrozis @trsvchn @hs094