ignite icon indicating copy to clipboard operation
ignite copied to clipboard

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

Open vfdev-5 opened this issue 4 years ago • 9 comments

📚 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 avatar Nov 13 '21 22:11 vfdev-5

Is this issue open to be taken up?

hs094 avatar Dec 10 '21 10:12 hs094

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 avatar Dec 10 '21 13:12 vfdev-5

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

hs094 avatar Dec 11 '21 05:12 hs094

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?

Moh-Yakoub avatar Jan 17 '22 12:01 Moh-Yakoub

@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 ?

vfdev-5 avatar Jan 17 '22 12:01 vfdev-5

@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 avatar Jan 17 '22 14:01 Moh-Yakoub

@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.

Moh-Yakoub avatar Jan 18 '22 17:01 Moh-Yakoub

Yes, I agree, thanks for the suggestion!

vfdev-5 avatar Jan 18 '22 17:01 vfdev-5

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 avatar Jan 18 '22 17:01 Moh-Yakoub