Repository navigation
Documentation is not Formatted Correctly(don't copy blindly from wiki) #22
Description
I think that all Documentation of aboutcode is very messed up and we should not just copy blindly from wiki and update here. Many of the docs are using an old version of the scancode-toolkit command, So we should take care of that and correct it then only we should push it. By just copying and pasting they look like very messed (the font is also not right, spacing is also not proper)and it will be a problem later because for modification we have to take a look on every page. So I think whenever we are updating doc of aboutcode we should modify it at that instant and then only we should push it.
The second thing is wiki doc is not well defined and are the quick tutorial. During forwarding it from wiki to aboutcode doc, we should take care of this also else this will cause a problem. Later, when we have to do modifications, then all previous work will be useless and we have to remove the code.
Activity
RituRajSingh878 commentedon Jun 25, 2019
@pombredanne
@MaJuRG
@DennisClark
What do you think?
[-]Documentation is not Fomatted Correctly(don't copy blindly from wiki)[/-][+]Documentation is not Formatted Correctly(don't copy blindly from wiki)[/+]jhasaurabh312 commentedon Aug 27, 2019
@RituRajSingh878 can i work on this issue?
RituRajSingh878 commentedon Aug 27, 2019
I am doing other projects so you can proceed. I don't know the current status of the problem so I think you should wait until you get some response from the mentor/member on this issue otherwise may be your work will be useless if already someone else have done it.
thanks
steven-esser commentedon Aug 27, 2019
I agree with @RituRajSingh878, we should avoid wholesale copying of wiki pages and submitting these for PR. We should at the very least attempt to convert these wiki docs to
rstformat, as many of them are in GH Wiki Markdown syntax. Outdated items in the wiki can be addressed on a case-by-case basis in the individual PRs.jhasaurabh312 commentedon Aug 27, 2019
@MaJuRG should I go on with this issue ?
steven-esser commentedon Aug 27, 2019
@jhasaurabh312 Contributions are always welcome.
jhasaurabh312 commentedon Aug 27, 2019
@MaJuRG Thanks !! I am onto it.
steven-esser commentedon Oct 24, 2019
@AyanSinhaMahapatra has been doing a lot of this work in various other issues and PRs. Also, this ticket is nebulous in scope so I am going to close this.
Additional specific issues can be addressed in new issues.