Questions about contributing to the documentation
-
I would like to contribute to the documentation and have a few questions.
- There are a number of open issues in the Github repo for the documentation. If there are no objections, I would suggest beginning with these: evaluating them to see if they are still relevant, closing the ones that are not immediately, and making updates / creating new content for the ones that still are. Who would be the right person to coordinate with, i.e. who is in charge of the documentation?
- The move from UT 16.04 to 20.04 may have rendered some sections of the existing documentation outdated. Will UT 16.04 continue to exist alongside UT 20.04? If so, might it be a good idea to preserve the existing documentation as it is, create a copy, and update the copy / create new content to reflect the current functionality of UT 20.04?
Ditching Big Tech is no longer optional.
I'm not trying to be a pain in the ass. It just comes naturally.
The universe is a big toy. I want to take it apart to see what makes it go.
Happily running Ubuntu Touch on:
Google Pixel 3a XL (20.04 Dev) -
@RayCulp said in Questions about contributing to the documentation:
I would like to contribute to the documentation
Thats great @RayCulp very much appreciated
- There are a number of open issues in the Github repo for the documentation. If there are no objections, I would suggest beginning with these: evaluating them to see if they are still relevant, closing the ones that are not immediately, and making updates / creating new content for the ones that still are.
Let me first take a step back and clarify that there isn't exactly an abundance of contributors to the docs.
As for how to start:
Like with many volunteer efforts, one good way to start is do what you like to do, are comfortable doing, "scratch your own itch". It's a way to create and sustain motivation for your self. If you feel like ticking the boxes of the open issues great - go for it, but it could be that some of the issues are very specific, not sure they are all up to date, or really representative of the highest priority tasks.
Another way, how I might do it, is just pick a topic or area that interests you. Read and review it and think about whether you like it as is, or want to change.
Who would be the right person to coordinate with, i.e. who is in charge of the documentation?
"in charge" is a big word, but I am the one who most consistently looks at the pull requests made
- The move from UT 16.04 to 20.04 may have rendered some sections of the existing documentation outdated. Will UT 16.04 continue to exist alongside UT 20.04? If so, might it be a good idea to preserve the existing documentation as it is, create a copy, and update the copy / create new content to reflect the current functionality of UT 20.04?
I would lean towards not doing this. It would of course be the best solution to have an extensive coverage, high quality and up to date docs for both, but I think it is just an unrealistic goal. As I mentioned there aren't a lot of contributions. So, it would be wiser to aim for a decent coverage, ok quality, and not terribly out of date for latest version only
-
@RayCulp Firstly thanks for offering to help. All help and contributions greatly received. Secondly though 16.04 will be around for a few more months I can only second what @doniks has said and put the work into 20.04 docs and information, that is the future now. Though if something affects both 16.04 and 20.04 docs and you want to update both you are free to but really there is little point as development on 16.04 has ended.
