Re: [libreoffice-documentation] User guide chapter development workflow
Hi Steve The whole process deserves a complete review because it does not fit with the pace of the development as well as it may not fit 2019 user demand. The process was rather good for a software release cycle of 12 or more months and the availability of authors. I'm thinking to move to a time-based release as with the software. In summary: At a given deadline, we publish the document/book "as is". I thought on a monthly or bi-monthy release of the full book(s). If mistakes or outdated information persist, we fix in the new "release" as time and availability permits. Release numbering can follow software numbering. This is the ideal world, things may not work so smooth in real world... Plenty of issues to address... First, we need to get the book(s) at its latest software release. Then we must be commited to update the text to follow the releases. Likely, intermediate releases do not carry changes in the software, only bug fixes. The update-revision-publish cycle has to go. We keep "update". "Revision and fixes" shifts to next book release. "Publish" is the latest released book, of last month. I imagine the build of the full book to now follow the usage of a master document, so the build is "automatic", "on-a-click" (*). The process needs management. No one can manage or coordinate all books, I suggest one coordinator per book. The community (i.e Authors) may want to put forward his/her name as coordinator of one of the books. The "(Book) Guide team" may want to work online directly (i.e no revision). Updates and new contents is to be written directly in the chapter stored in the cloud. Trust in Author competences is necessary. The desktop, NextCloud + LibreOffice online, wiki and websites are the tools we need to work. Issues to address... The fast and continuous update of the books puts a challenge to the non-English community that wants to translate the books. To be addressed. The process may frighten newcommers specially people that are not confident on using LibreOffice. The quality of our publications will reflect this competences. We don't have a tool to report mistakes in the books besides mailing list or direct mail to me. To be adressed. I stop here for the moment waiting for comments, if we move ahead in this direction or find another way to get our literature released. Shall we open a wiki page or cloud document to anotate all ideas? Kind regards Olivier (*) Today Jean Weber kindly assembles the book by concatenating chapters and adjusting the contents (e.g. removing the TOC of each chapter, remove pesky direct formatting left, fix many internal glitches) and this work takes significant time and effort, which we aim to avoid. Master documents have their own set of issues too, but with proper tweak in chapters, I think (wishfull thinking !) it can be faster. Em 16/09/2019 06:40, Steve Fanning escreveu: > I am trying to better understand the Documentation Team’s current > process for developing user guides. I have two objectives - firstly to > make sure I follow the processes correctly and secondly to update the > wiki page entitled “Chapter 3 Using the LibreOffice Documentation Team > Website”. Please note that I’m not trying to change any part of the > process, simply trying to better understand what we already do. > > I have three questions arising from the existing workflow diagram (see > https://wiki.documentfoundation.org/File:Workflow.png), which I believe > reflects the pre-Nextcloud process and may need updating. > > (1) Do we still have four discrete roles in the workflow, i.e. > Writer, Reviewer, Editor and Publisher? > > (2) My current understanding is that Writer uploads his drafts to the > Feedback folder in Nextcloud (rather than Draft). Is that correct? > > (3) At what point does the chapter get uploaded to the Draft folder, > and by which role? > > Thanks for any help. > > Regards, > > Steve Fanning > > > -- Olivier Hallot LibreOffice Documentation Coordinator Comunidade LibreOffice Rio de Janeiro - Brasil - Local Time: UTC-03:00 http://tdf.io/joinus -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
Re: [libreoffice-documentation] Infra announce: Authenticating against gerrit using TDF's Single Sign-On system
Hi Luke Gerrit and Documentation intersects when we update or write a Help page. In case you are curious (and bold to jump into the Help editing), you may want to read this: https://wiki.documentfoundation.org/Documentation/GerritEditing Kind regards Olivier Em 17/09/2019 02:57, Luke (gmail) escreveu: > Not that my confusion is significant, but I just thought I'd mention I > have no idea what gerrit is, have no gerrit account, and have no idea of > the broader context of this message. > > My confusion may relate to my single failed attempt to share some sample > documentation by attaching a doc to a message to this list. I think that > probably tells you just how much of a newbie I am. But there's also a > chance it indicates it's not so easy to get the big picture of the > processes one is supposed to follow, to contribute to this free > documentation effort. > > luke > > On 15/9/19 9:28 pm, Guilhem Moulin wrote: >> Dear developers, >> >> Please visit https://user.documentfoundation.org/edit (use your Single >> Sign-On credentials to authenticate — if you don't have an account there >> then please create one) and check whether you have “Gerrit” in the >> “Linked profiles” section. If not, then add the preferred email address >> of your gerrit account [0] to the form above; a confirmation token will >> then be delivered to that address, and “Gerrit” should appear in the >> “Linked profiles” section after confirmation. >> >> About 68% of the gerrit accounts who uploaded a patch set in the past 30 >> days are known to the Single Sign-On system. These accounts can use >> TDF's >> new OAuth2 IdP at https://gerrit.libreoffice.org/login/ i.e., >> authenticate >> through The Document Foundation's Single Sign-On system. >> >> Unfortunately, due to the way the OAuth2 plugin work, if you try a new >> IdP >> that is not linked to your existing gerrit account, then a *brand new* >> account is created. (This is no different than for other providers like >> GitHub or Google.) If that happens, then please *do not* start using the >> new account, instead ask us to merge them ASAP at >> hostmas...@documentfoundation.org >> (or on IRC at #tdf-infra). While merging a fresh account is painless, >> the >> logic is more brittle (there is risk of breaking referential >> integrity) if >> they're both actively used, so again please poke us ASAP. >> >> In the not too distant future, TDF's OAuth2 IdP will become the *only* >> way >> to authenticate against our gerrit instance: authenticating using other >> OAuth2 or OpenID providers will no longer be possible. We're unable to >> give a precise ETA right now, as we need a higher ratio of patchsets >> authors in SSO, but that will definitely be *in 2019*. Later this week >> we'll individually poke all recent patchsets authors that are still >> unknown from our Single Sign-On system. Once we deprecate other OAuth2 >> and OpenID providers, gerrit accounts that are still missing from SSO >> will >> be effectively *locked out* until an infra team member manually tie them >> up to the relevant LDAP DIT entry. >> >> FWIW finalizing the migration to TDF's OAuth2 IdP is a prerequisite for >> upgrading gerrit to more recent versions (with shiny new Web UI, ed25519 >> SSH key support, CodeMirror editor plugin, and more [1]). >> > > -- Olivier Hallot LibreOffice Documentation Coordinator Comunidade LibreOffice Rio de Janeiro - Brasil - Local Time: UTC-03:00 http://tdf.io/joinus -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
Re: [libreoffice-documentation] Infra announce: Authenticating against gerrit using TDF's Single Sign-On system
kees...@libreoffice.org wrote on 9/17/19 9:28 AM: > I also have no idea what Gerrit is, but the mail started with "Dear > developpers" so I quessed it was only ment for developpers, which I am not. https://wiki.documentfoundation.org/Development/gerrit Don't read to much... " This is the entry page on the code review tool gerrit.libreoffice.org and how to use it in LibreOffice. " But gerrit is also used for some other review processes. E.g. membership applications. -- Cor Nouws GPD key ID: 0xB13480A6 - 591A 30A7 36A0 CE3C 3D28 A038 E49D 7365 B134 80A6 - vrijwilliger https://nl.libreoffice.org - volunteer https://www.libreoffice.org - Member Board The Document Foundation - http://www.nouenoff.nl / https://www.mijncloudoffice.nl -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
Re: [libreoffice-documentation] Infra announce: Authenticating against gerrit using TDF's Single Sign-On system
Please keep in mind that messages sent to a mailing list have potentially a large number of receivers. And typically a messages is not directed to individuals. Use the preferred search engine to find out what Gerrit is used for: https://en.wikipedia.org/wiki/Gerrit_(software) https://wiki.documentfoundation.org/Development/gerrit (In a nutshell: Gerrit is used to receive, integrate, and review the source code from all developers) And ideally improve the documentation, if you think it's needed :-). Cheers, Heiko PS: The tech-talk by our infra people deserves some clarification: OAuth2 IdP, LDAP DIT entry, ed25519 SSH key support, CodeMirror editor plugin... not to mention ASAP, FWIW etc. On 17.09.19 09:28, kees...@libreoffice.org wrote: > I also have no idea what Gerrit is... > Luke (gmail) schreef op 17.09.2019 07:57: >> Not that my confusion is significant, but I just thought I'd mention I >> have no idea what gerrit is... -- To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
