Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
Arcadiy Ivanov
@arcivanov
ok so
Lonerider2010
@Lonerider2010
Which branch should I use? master or sth. else?
Arcadiy Ivanov
@arcivanov
if you just clone you can't push
Lonerider2010
@Lonerider2010
Ok, I will do that later.
Arcadiy Ivanov
@arcivanov
step 2, clone the fork
Lonerider2010
@Lonerider2010
Ok.
Arcadiy Ivanov
@arcivanov
step 3, git checkout doc/sphinxdoc
step 4, git checkout -b <name of the branch to aggregate your change in>
step 5, make changes
step 6, git commit, git push (that's why you need the fork)
Lonerider2010
@Lonerider2010
If it's ok for you, I would like to start with walkthrough-new and change the outputs from the command line according to version 0.11.17
Arcadiy Ivanov
@arcivanov
step 7, submit PR
It's perfectly OK with me, you should feel free to work on whatever parts you think best, but please do it in a structured way to keep the changes reviewable
Lonerider2010
@Lonerider2010
ok, I will note the steps you mentioned and follow them. If I have some trouble, I will contact you again.
Arcadiy Ivanov
@arcivanov
whatever progress you can make will be an improvement
thanks! :thumbsup:
Lonerider2010
@Lonerider2010
Sure, I will do that. Thanks for your time now. It will take me some time to proceed, but will get back to you as soon as possible.
Arcadiy Ivanov
@arcivanov
@Lonerider2010 I'm here
what's up
Lonerider2010
@Lonerider2010
@arcivanov : can we chat now?
Ok, I'll try it again in one hour.
Lonerider2010
@Lonerider2010
@arcivanov hello again
@arcivanov Please tell me, when is the best time of day for you for a chat?
As I need to clarify with you, how to proceed.
Arcadiy Ivanov
@arcivanov
My time fo day changes based on work demands
Lonerider2010
@Lonerider2010
@arcivanov Trying to contact you.
Arcadiy Ivanov
@arcivanov
hi
in meeting right now
Lonerider2010
@Lonerider2010
Ok, when will you have some minutes for me?
in one or two hours?
Arcadiy Ivanov
@arcivanov
I should be off in like 10 min
Lonerider2010
@Lonerider2010
Ok, I will wait till then.
Arcadiy Ivanov
@arcivanov
ok, I'm here, what's up?
Lonerider2010
@Lonerider2010
Hi, thanks for your time. Just wanted to clarify with you how the change and review workflow is defined for Sphinx.
Because I did not find any help for that.
Do you have any information on that topic?
Arcadiy Ivanov
@arcivanov
on how to modify Sphinx documentation?
Lonerider2010
@Lonerider2010
Yes, and how you would put remarks on these modifications?
Arcadiy Ivanov
@arcivanov
you don't put remarks
you make changes
commit in your branch
submit a PR into upstream repo
and then the changes get reviewed
one sec
so rst files are where the documentation is
some of the documentation is generated from them
some is auto-generated
Lonerider2010
@Lonerider2010
Yes, I know. So I can follow you on the steps you described. But the last point, how is the review done? On the PDF, on the HTML files?
Arcadiy Ivanov
@arcivanov
neither