Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On Mon, May 16, 2016 at 4:54 PM, Doug Smythies wrote: > On 2016.01.03 7:58 Peter Matulis wrote: > > On 01/03/2014 10:43 AM, Peter Matulis wrote: > >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: > > [...] > > Don't forget to install Sphinx. > > $ sudo apt-get install sphinx-doc > > Into my main 16.04 test server, the one on which I compile Ubuntu docs, I > installed "sphinx-doc", but an HTML compile attempt still error exits with: > > doug@s15:~/sguide-peter/p$ make html > sphinx-build -b html -d _build/doctrees . _build/html > make: sphinx-build: Command not found > Makefile:45: recipe for target 'html' failed > make: *** [html] Error 127 > > I could confirm the issue, but the following gets it working for me $ sudo apt-get install python3-sphinx -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
RE: Calling for Server Guide reviewers/contributors - - TRUSTY
On 2016.01.03 7:58 Peter Matulis wrote: > On 01/03/2014 10:43 AM, Peter Matulis wrote: >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: >>> I can help; it would be a good way to understand the new format. >>> Should I do what you did and fetch a chapter somehow, edit it and >>> place it somewhere so it can be seen before brought back? >> >> Let's work from here: >> >> https://code.launchpad.net/~petermatulis/+junk/serverguide-rst >> >> You can make a branch of that and then I can occasionally merge in your >> new work. > > Mauricio, and anyone else, start by looking at installation.rst. It > contains good samples of the new way of doing things. For the > cross-reference link to the 'Aptitude' heading you will also need to > look at package-management.rst. Hi Peter, We just did an update publish of the 16.04 serverguide on help.ubuntu.com. To me it seems like a good time to look deeper into a possible markdown language change. I wanted to build the Ubuntu Serverguide from your markdown test project and compare. Could you update it from the DocBook master source? I didn't see a "PDF" option in the Makefile. Is there a way to compile the PDF version of the Serverguide? Perhaps I should use "latexpdf"? > Don't forget to install Sphinx. > $ sudo apt-get install sphinx-doc Into my main 16.04 test server, the one on which I compile Ubuntu docs, I installed "sphinx-doc", but an HTML compile attempt still error exits with: doug@s15:~/sguide-peter/p$ make html sphinx-build -b html -d _build/doctrees . _build/html make: sphinx-build: Command not found Makefile:45: recipe for target 'html' failed make: *** [html] Error 127 Linux s15 4.4.0-21-generic #37-Ubuntu SMP Mon Apr 18 18:33:37 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux doug@s15:~/sguide-trunk/x/build$ dpkg -l | grep sph ii libjs-sphinxdoc 1.3.6-2ubuntu1 JavaScript support for Sphinx documentation ii sphinx-doc 1.3.6-2ubuntu1 documentation generator for Python projects - documentation ... Doug -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
Quoting Doug Smythies (dsmyth...@telus.net): > > On 2014.02.06 15:05 Serge Hallyn wrote: > > Quoting Peter Matulis (peter.matu...@canonical.com): > >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: > >>> On Fri, Jan 3, 2014 at 5:58 AM, Peter Matulis > >> > After having spent a good part of the day going through just one file > (chapter) I now know how much work is involved: > > 1. A good number of external links are broken > 2. All internal links are broken and require a new way of linking > (source and destination) > 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not > outright broken > 4. All working external links *should* be changed to a new format > 5. Heading organization need to be redone in all chapters. All > chapters > have multiple 1st level headings. This is what was causing the > flattened/expansize table of contents I mentioned earlier. > 6. More theme/customization work > 7. Research how this conversion will affect the translators and come up > with a corrective plan > > I can't do all this myself; I estimate there is about 120 hours of work > required. Anyone? > > >>> I can help; it would be a good way to understand the new format. > >>> Should I do what you did and fetch a chapter somehow, edit it and > >>> place it somewhere so it can be seen before brought back? > >> > >> Let's work from here: > >> > >> https://code.launchpad.net/~petermatulis/+junk/serverguide-rst > >> > >> You can make a branch of that and then I can occasionally merge in your > >> new work. > > > Oh, drat, I was starting from lp:serverguide (with small update pushed > > to lp:~serge-hallyn/serverguide/lxc-trusty-update) > > > I'll take a look at your tree. (The lxc update will need to be > > extensive) > > Serge: Please continue your work with lp:serverguide as the master code. > > There is no way there will be a change over before the serverguide 14.04 > is released. > > This thread stalled out when trying to estimate the translations > portion of the project (at least that is my understanding). > > Please consider to put your name under Chapter 20.4 on: > > https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGu > ide > > the serverguide task list, as reviewing it. > > The serverguide doc team is very grateful for your help. Ok, thanks for the info. FWIW I intend to cut quite a bit out of the section (as well as add information on new features) in order to make it more readable, more maintainable, and less redundant (i.e. refer to the manpages rather than list detailed lxc.conf info) So it's going to be more of a re-write than a review. -serge -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
RE: Calling for Server Guide reviewers/contributors - - TRUSTY
On 2014.02.06 15:05 Serge Hallyn wrote: > Quoting Peter Matulis (peter.matu...@canonical.com): >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: >>> On Fri, Jan 3, 2014 at 5:58 AM, Peter Matulis >> After having spent a good part of the day going through just one file (chapter) I now know how much work is involved: 1. A good number of external links are broken 2. All internal links are broken and require a new way of linking (source and destination) 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not outright broken 4. All working external links *should* be changed to a new format 5. Heading organization need to be redone in all chapters. All chapters have multiple 1st level headings. This is what was causing the flattened/expansize table of contents I mentioned earlier. 6. More theme/customization work 7. Research how this conversion will affect the translators and come up with a corrective plan I can't do all this myself; I estimate there is about 120 hours of work required. Anyone? >>> I can help; it would be a good way to understand the new format. >>> Should I do what you did and fetch a chapter somehow, edit it and >>> place it somewhere so it can be seen before brought back? >> >> Let's work from here: >> >> https://code.launchpad.net/~petermatulis/+junk/serverguide-rst >> >> You can make a branch of that and then I can occasionally merge in your >> new work. > Oh, drat, I was starting from lp:serverguide (with small update pushed > to lp:~serge-hallyn/serverguide/lxc-trusty-update) > I'll take a look at your tree. (The lxc update will need to be > extensive) Serge: Please continue your work with lp:serverguide as the master code. There is no way there will be a change over before the serverguide 14.04 is released. This thread stalled out when trying to estimate the translations portion of the project (at least that is my understanding). Please consider to put your name under Chapter 20.4 on: https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGu ide the serverguide task list, as reviewing it. The serverguide doc team is very grateful for your help. -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
Quoting Peter Matulis (peter.matu...@canonical.com): > On 01/03/2014 01:08 AM, Mauricio Tavares wrote: > > On Fri, Jan 3, 2014 at 5:58 AM, Peter Matulis > > >> After having spent a good part of the day going through just one file > >> (chapter) I now know how much work is involved: > >> > >> 1. A good number of external links are broken > >> 2. All internal links are broken and require a new way of linking > >> (source and destination) > >> 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not > >> outright broken > >> 4. All working external links *should* be changed to a new format > >> 5. Heading organization need to be redone in all chapters. All chapters > >> have multiple 1st level headings. This is what was causing the > >> flattened/expansize table of contents I mentioned earlier. > >> 6. More theme/customization work > >> 7. Research how this conversion will affect the translators and come up > >> with a corrective plan > >> > >> I can't do all this myself; I estimate there is about 120 hours of work > >> required. Anyone? > >> > > I can help; it would be a good way to understand the new format. > > Should I do what you did and fetch a chapter somehow, edit it and > > place it somewhere so it can be seen before brought back? > > Let's work from here: > > https://code.launchpad.net/~petermatulis/+junk/serverguide-rst > > You can make a branch of that and then I can occasionally merge in your > new work. Oh, drat, I was starting from lp:serverguide (with small update pushed to lp:~serge-hallyn/serverguide/lxc-trusty-update) I'll take a look at your tree. (The lxc update will need to be extensive) -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On Wed, Jan 8, 2014 at 3:25 PM, Elizabeth Krumbach Joseph wrote: > On Tue, Jan 7, 2014 at 6:09 AM, Peter Matulis > wrote: >> On 01/03/2014 01:18 PM, Elizabeth Krumbach Joseph wrote: >>> On Fri, Jan 3, 2014 at 9:37 AM, Doug Smythies wrote: However, I think item 7, translations and the overall workflow is the unknown at this time, and could be a major hurtle or even a show stopper. We need to estimate that part of the project for feasibility, person hours, and potential timeline for implementation. Myself, I would put a hold on items 1-6 for now. Myself, I do not know how to even start looking into item 7, but I'll help if possible. >>> >>> Huge +1 here. This is an LTS release and I'm not sure this is the best >>> time to take upon this major overhaul given the amount of time >>> involved and the uncertainty about translations. Translations are very >>> important, particularly in an LTS, and we do a great disservice to our >>> translations volunteers if we do this without a plan for them, or >>> otherwise abruptly change things for them. How ever we do this, it's >>> likely that all strings will be shown as modified and they'll have to >>> begin translations from scratch rather than just updating changed >>> strings. >>> >>> I'd feel much better doing this for 14.10, when it's a bit less >>> important to have a solid, translated documentation for release. >> >> As we know, there is a chorus that goes up at every UDS that says we >> should change away from XML but no one ever did anything. I decided to >> push forward with this in order to i) see what would be involved and ii) >> provoke reactions from people. From what I can see I've achieved both >> goals. >> >> It would be great if a knowledgeable person from Translations could get >> in contact with me about the impact this transition would have for them. > > Your best bet is probably the translators mailing list: > ubuntu-translators@lists.ubuntu.com Oops, this is already on the translators list, the translator *coordinators* may be the ones to talk to: https://launchpad.net/~ubuntu-translations-coordinators -- Elizabeth Krumbach Joseph || Lyz || pleia2 http://www.princessleia.com -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On Tue, Jan 7, 2014 at 6:09 AM, Peter Matulis wrote: > On 01/03/2014 01:18 PM, Elizabeth Krumbach Joseph wrote: >> On Fri, Jan 3, 2014 at 9:37 AM, Doug Smythies wrote: >>> However, I think item 7, translations and the overall workflow is >>> the unknown at this time, and could be a major hurtle or even a >>> show stopper. We need to estimate that part of the project for >>> feasibility, person hours, and potential timeline for implementation. >>> Myself, I would put a hold on items 1-6 for now. >>> Myself, I do not know how to even start looking into item 7, but >>> I'll help if possible. >> >> Huge +1 here. This is an LTS release and I'm not sure this is the best >> time to take upon this major overhaul given the amount of time >> involved and the uncertainty about translations. Translations are very >> important, particularly in an LTS, and we do a great disservice to our >> translations volunteers if we do this without a plan for them, or >> otherwise abruptly change things for them. How ever we do this, it's >> likely that all strings will be shown as modified and they'll have to >> begin translations from scratch rather than just updating changed >> strings. >> >> I'd feel much better doing this for 14.10, when it's a bit less >> important to have a solid, translated documentation for release. > > As we know, there is a chorus that goes up at every UDS that says we > should change away from XML but no one ever did anything. I decided to > push forward with this in order to i) see what would be involved and ii) > provoke reactions from people. From what I can see I've achieved both > goals. > > It would be great if a knowledgeable person from Translations could get > in contact with me about the impact this transition would have for them. Your best bet is probably the translators mailing list: ubuntu-translators@lists.ubuntu.com I've also included David Planella in the Cc: to see if he can give some feedback (he's worked with the translations teams for several years). -- Elizabeth Krumbach Joseph || Lyz || pleia2 http://www.princessleia.com -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On 01/03/2014 01:18 PM, Elizabeth Krumbach Joseph wrote: > On Fri, Jan 3, 2014 at 9:37 AM, Doug Smythies wrote: >> However, I think item 7, translations and the overall workflow is >> the unknown at this time, and could be a major hurtle or even a >> show stopper. We need to estimate that part of the project for >> feasibility, person hours, and potential timeline for implementation. >> Myself, I would put a hold on items 1-6 for now. >> Myself, I do not know how to even start looking into item 7, but >> I'll help if possible. > > Huge +1 here. This is an LTS release and I'm not sure this is the best > time to take upon this major overhaul given the amount of time > involved and the uncertainty about translations. Translations are very > important, particularly in an LTS, and we do a great disservice to our > translations volunteers if we do this without a plan for them, or > otherwise abruptly change things for them. How ever we do this, it's > likely that all strings will be shown as modified and they'll have to > begin translations from scratch rather than just updating changed > strings. > > I'd feel much better doing this for 14.10, when it's a bit less > important to have a solid, translated documentation for release. As we know, there is a chorus that goes up at every UDS that says we should change away from XML but no one ever did anything. I decided to push forward with this in order to i) see what would be involved and ii) provoke reactions from people. From what I can see I've achieved both goals. It would be great if a knowledgeable person from Translations could get in contact with me about the impact this transition would have for them. ~pmatulis -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On Fri, Jan 3, 2014 at 9:37 AM, Doug Smythies wrote: > However, I think item 7, translations and the overall workflow is > the unknown at this time, and could be a major hurtle or even a > show stopper. We need to estimate that part of the project for > feasibility, person hours, and potential timeline for implementation. > Myself, I would put a hold on items 1-6 for now. > Myself, I do not know how to even start looking into item 7, but > I'll help if possible. Huge +1 here. This is an LTS release and I'm not sure this is the best time to take upon this major overhaul given the amount of time involved and the uncertainty about translations. Translations are very important, particularly in an LTS, and we do a great disservice to our translations volunteers if we do this without a plan for them, or otherwise abruptly change things for them. How ever we do this, it's likely that all strings will be shown as modified and they'll have to begin translations from scratch rather than just updating changed strings. I'd feel much better doing this for 14.10, when it's a bit less important to have a solid, translated documentation for release. -- Elizabeth Krumbach Joseph || Lyz || pleia2 http://www.princessleia.com -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
RE: Calling for Server Guide reviewers/contributors - - TRUSTY
On 2014.01.03 07:58 Peter Matulis wrote: > On 01/03/2014 10:43 AM, Peter Matulis wrote: >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: >>> I can help; it would be a good way to understand the new format. >>> Should I do what you did and fetch a chapter somehow, edit it and >>> place it somewhere so it can be seen before brought back? >> >> Let's work from here: >> >> https://code.launchpad.net/~petermatulis/+junk/serverguide-rst >> >> You can make a branch of that and then I can occasionally merge in your >> new work. > Mauricio, and anyone else, start by looking at installation.rst. It > contains good samples of the new way of doing things. For the > cross-reference link to the 'Aptitude' heading you will also need to > look at package-management.rst. Also adding back: On 2014.01.02 20:58 Peter had written: > After having spent a good part of the day going through just one file > (chapter) I now know how much work is involved: > 1. A good number of external links are broken > 2. All internal links are broken and require a new way of linking > (source and destination) > 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not > outright broken > 4. All working external links *should* be changed to a new format > 5. Heading organization need to be redone in all chapters. All chapters > have multiple 1st level headings. This is what was causing the > flattened/expansize table of contents I mentioned earlier. > 6. More theme/customization work > 7. Research how this conversion will affect the translators and come up > with a corrective plan > I can't do all this myself; I estimate there is about 120 hours of work > required. Anyone? It is just my opinion, but I think we are getting ahead of ourselves here. Peter has a come up with an estimate for items 1-6, which is good. Some contingency time should be added to that estimate for issues not yet discovered (for example some tables are missing completely and some are not). For example, we are still finding issues with the "new" theme in the existing server guide after 2 almost two years. However, I think item 7, translations and the overall workflow is the unknown at this time, and could be a major hurtle or even a show stopper. We need to estimate that part of the project for feasibility, person hours, and potential timeline for implementation. Myself, I would put a hold on items 1-6 for now. Myself, I do not know how to even start looking into item 7, but I'll help if possible. ... Doug -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On 01/03/2014 10:57 AM, Peter Matulis wrote: > On 01/03/2014 10:43 AM, Peter Matulis wrote: >> On 01/03/2014 01:08 AM, Mauricio Tavares wrote: > >>> I can help; it would be a good way to understand the new format. >>> Should I do what you did and fetch a chapter somehow, edit it and >>> place it somewhere so it can be seen before brought back? >> >> Let's work from here: >> >> https://code.launchpad.net/~petermatulis/+junk/serverguide-rst >> >> You can make a branch of that and then I can occasionally merge in your >> new work. > > Mauricio, and anyone else, start by looking at installation.rst. It > contains good samples of the new way of doing things. For the > cross-reference link to the 'Aptitude' heading you will also need to > look at package-management.rst. Don't forget to install Sphinx. $ sudo apt-get install sphinx-doc peter -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On 01/03/2014 10:43 AM, Peter Matulis wrote: > On 01/03/2014 01:08 AM, Mauricio Tavares wrote: >> I can help; it would be a good way to understand the new format. >> Should I do what you did and fetch a chapter somehow, edit it and >> place it somewhere so it can be seen before brought back? > > Let's work from here: > > https://code.launchpad.net/~petermatulis/+junk/serverguide-rst > > You can make a branch of that and then I can occasionally merge in your > new work. Mauricio, and anyone else, start by looking at installation.rst. It contains good samples of the new way of doing things. For the cross-reference link to the 'Aptitude' heading you will also need to look at package-management.rst. peter -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On 01/03/2014 01:08 AM, Mauricio Tavares wrote: > On Fri, Jan 3, 2014 at 5:58 AM, Peter Matulis >> After having spent a good part of the day going through just one file >> (chapter) I now know how much work is involved: >> >> 1. A good number of external links are broken >> 2. All internal links are broken and require a new way of linking >> (source and destination) >> 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not >> outright broken >> 4. All working external links *should* be changed to a new format >> 5. Heading organization need to be redone in all chapters. All chapters >> have multiple 1st level headings. This is what was causing the >> flattened/expansize table of contents I mentioned earlier. >> 6. More theme/customization work >> 7. Research how this conversion will affect the translators and come up >> with a corrective plan >> >> I can't do all this myself; I estimate there is about 120 hours of work >> required. Anyone? >> > I can help; it would be a good way to understand the new format. > Should I do what you did and fetch a chapter somehow, edit it and > place it somewhere so it can be seen before brought back? Let's work from here: https://code.launchpad.net/~petermatulis/+junk/serverguide-rst You can make a branch of that and then I can occasionally merge in your new work. peter -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
Re: Calling for Server Guide reviewers/contributors - - TRUSTY
On 01/02/2014 03:52 PM, Tom Davies wrote: > Hi :) > I quite liked it's simplicity but is it possible to move the "Quick > Search" feature to the top of the column (on the right) rather than > leaving it at the bottom? > > The contents lists are quite long so people probably don't instantly > realise the functionality exists. Also putting it at the top-right > would make it more consistent with other wiki's wouldn't it? (err, i > don't know now since i haven't checked for ages!) > > Anyway, good work so far! > Congrats and regards from > Tom :) > > > > On 2 January 2014 18:36, Mauricio Tavares wrote: >> On Thu, Jan 2, 2014 at 6:13 PM, Peter Matulis >> wrote: >>> On 12/13/2013 01:25 AM, William Van Hevelingen wrote: Yeah...looks like those didn't get converted. It shouldn't be that much effort to fix all the headers. The internal links will have to be fixed too, maybe a sed script can fix them up. I used sphinx to generate some html and posted it here: http://web.cecs.pdx.edu/~wvan/serverguide/remote-administration.html Not really sure how to make the index/homepage work yet but this is a work in progress. :) Do you have any feedback so besides the other items you mentioned? Btw `make lintcheck` is awesome. It reports on all the broken external links and we can hook it up to continuous integration. >>> >>> Here is my own attempt, including some branding. Feedback welcome. >>> Yes, there are still broken links and the table of contents is too >>> expansive. I really like the streamlined markup (see 'Show Source' at >>> the bottom of the TOC). >>> >>> http://serverguide.papamike.ca:8081 >>> >>I think it looks nice; I do like simple clean interfaces so you >> can focus on content. How many header levels can you have with it? >> >> With that in mind, now I have some free time I personally want to >> figure out my ssh key issue and then populate some of the docs. For >> that, I do not care about whatever format we choose; just make sure we >> can convert from the current to the new style with as little pain as >> possible. >> >> In the mean time, I can work and flesh out my notes until I can start >> working on those docs. I would like to be able to sit down on the >> weekend and get stuff done. Ideally one topic per weekend. After having spent a good part of the day going through just one file (chapter) I now know how much work is involved: 1. A good number of external links are broken 2. All internal links are broken and require a new way of linking (source and destination) 3. All admonitions (i.e. "notes" and "warnings") are crippled, but not outright broken 4. All working external links *should* be changed to a new format 5. Heading organization need to be redone in all chapters. All chapters have multiple 1st level headings. This is what was causing the flattened/expansize table of contents I mentioned earlier. 6. More theme/customization work 7. Research how this conversion will affect the translators and come up with a corrective plan I can't do all this myself; I estimate there is about 120 hours of work required. Anyone? pmatulis -- ubuntu-translators mailing list ubuntu-translators@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-translators
