Page MenuHomeSoftware Heritage

developers faq: Define faq with categories
ClosedPublic

Authored by ardumont on Jun 17 2021, 5:57 PM.

Details

Summary

This opens the developers faq we short-listed during the documentation sprint. Question are
regrouped under a specific category.

Categories are listed from the main page and from the left menu.

Related to T3119

Test Plan

make -C docs html
Then checks the rendering with browser

Diff Detail

Repository
rDDOC Development documentation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

ardumont created this revision.

Why don't you move docs/faq/faq.rst to docs/faq/index.rst?

Why don't you move docs/faq/faq.rst to docs/faq/index.rst?

ah, lol because i'm not that much fluent in sphinx coolness ;)
(i'll adapt tomorrow)

Why don't you move docs/faq/faq.rst to docs/faq/index.rst?

ah, lol because i'm not that much fluent in sphinx coolness ;)
(i'll adapt tomorrow)

Well, i can't seem to make it work as it is described now so i won't adapt after all.
To me, that's not a blocker point, and we can improve this technical detail later.

vlorentz added inline comments.
docs/faq/faq.rst
111–112
This revision is now accepted and ready to land.Jun 18 2021, 10:36 AM
ardumont retitled this revision from development-faq: Update with categories to developers faq: Define faq with categories.Jun 18 2021, 10:43 AM
ardumont edited the summary of this revision. (Show Details)
  • Adapt according to suggestion
  • reword commit message

Thanks @ardumont !
Looks good, I have a few comments for the answers (nothing major).

With the image it seems that each section is separated in a different page, instead
of having one full page, is that something that can be modified ?

docs/faq/faq.rst
9

add link to the internships page

16

I don't see in the dev-setup hardware requirements. or if there is an OS requirement?
So I would add that and add this phrase:

Python 3.7 or newer is required

42

is it maintained?

Maybe add the link to the forge as well

61

put it last, because this is usually not for technical help

62

delete

63

put this first and add specifically the swh-devel mailing list and IRC channel

80

Add:

To setup a job on your local machine, you need to get a task into celery.

(not sure it's correct???)

81
132

where can I get this form?

With the image it seems that each section is separated in a different page, instead
of having one full page, is that something that can be modified ?

It's already one page as you mentioned in irc ;)

10:59 <moranegg[m]> ardumont: just submitted and i was wrong about the image
ardumont added inline comments.
docs/faq/faq.rst
42

is it maintained?

I believe it is and serve mainly as a list of other links (abstracting away from the
internal detail of what forge we use).

Currently we'll duplicate information with the wiki
and we'll need to update it if we migrate to gitlab... (thus needing to fix it twice...)

Adapting nonetheless (as a user i don't quite like manual indirection anways).

132

When opening the diff the first time, i don't know where it's located exactly, probably on the forge in some phabricator rule or on the intranet (maybe both).

ardumont marked an inline comment as done.

Adapt some more according to review