Re: [Firebird-docs] Firebird File and Metadata Security migrated
On 01-07-2020 18:59, Mark Rotteveel wrote: > > A large table of contents that covers everything will only overwhelm. I think > a short list of the documentation with a short > summary of the subjects covered would be better than a cross-document > table-of-contents. > > But I also think that some of the existing documentation should maybe be > moved to an 'attic' (as in: move it out of the way, but keep it accessible as > it might be interesting for some, but generally not > very useful due to age > or incompleteness). > > Mark > -- > Mark Rotteveel Well, I don't want a TOC for everything. But everything that covers our product "Firebird" should be accessible in one place. So an outstanding guy will find useful information in one place. Of course this can be a single page or something else. Regards Martin ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
[Firebird-docs] [FirebirdSQL/firebird-documentation] 23670c: Added attributes-de.adoc in nbackup-de. Note from ...
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 23670c6d3b2974565e501a62278ff9703ed7c8b1 https://github.com/FirebirdSQL/firebird-documentation/commit/23670c6d3b2974565e501a62278ff9703ed7c8b1 Author: Martin Köditz Date: 2020-07-01 (Wed, 01 Jul 2020) Changed paths: M src/docs/asciidoc/de/firebirddocs/nbackup/firebird-nbackup-de.adoc Log Message: --- Added attributes-de.adoc in nbackup-de. Note from Mark. Commit: e6df86ca1cf7ab1543d34690205682c0d3b10d49 https://github.com/FirebirdSQL/firebird-documentation/commit/e6df86ca1cf7ab1543d34690205682c0d3b10d49 Author: Martin Köditz Date: 2020-07-01 (Wed, 01 Jul 2020) Changed paths: M src/docs/asciidoc/de/firebirddocs/fbcache/firebird-cache-de.adoc M src/docs/asciidoc/de/firebirddocs/generatorguide/firebird-generatoren-ratgeber.adoc M src/docs/asciidoc/de/refdocs/fblangref25/firebird-25-sprachreferenz.adoc A src/docs/asciidoc/en/firebirddocs/fbmetasecur/firebird-metadata-security.adoc M src/docs/asciidoc/fb-docs-redirects.txt A src/docs/asciidoc/pt_BR/attributes-pt_BR.adoc A src/docs/asciidoc/pt_BR/firebirddocs/fbmetasecur/firebird-metadata-security-pt_br.adoc A src/docs/asciidoc/ru/firebirddocs/fbmetasecur/firebird-metadata-security-ru.adoc M src/docs/asciidoc/ru/firebirddocs/generatorguide/firebird-generator-guide-ru.adoc R src/docs/firebirddocs-pt_br/fbmetasecur-pt_br.xml M src/docs/firebirddocs-pt_br/firebirddocs-pt_br.xml R src/docs/firebirddocs-ru/fbmetasecur-ru.xml M src/docs/firebirddocs-ru/firebirddocs-ru.xml R src/docs/firebirddocs/fbmetasecur.xml M src/docs/firebirddocs/firebirddocs.xml Log Message: --- Merge branch 'master' of https://github.com/FirebirdSQL/firebird-documentation Compare: https://github.com/FirebirdSQL/firebird-documentation/compare/2bb1540c17ca...e6df86ca1cf7 ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] Firebird File and Metadata Security migrated
On 01-07-2020 18:43, Köditz, Martin wrote: I think a large table of contents makes sense. Even I find it difficult to find documents sometimes. How should a newcomer know in which area a document is or that it exists at all. That's why I prefer a single large table of contents. A large table of contents that covers everything will only overwhelm. I think a short list of the documentation with a short summary of the subjects covered would be better than a cross-document table-of-contents. But I also think that some of the existing documentation should maybe be moved to an 'attic' (as in: move it out of the way, but keep it accessible as it might be interesting for some, but generally not very useful due to age or incompleteness). Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
[Firebird-docs] [FirebirdSQL/firebird-documentation] 2bb154: Migrate fbmetasecur.xml, fbmetasecur-pt_br.xml, fb...
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 2bb1540c17ca4523144124d7a9c6e5b89f1ffd6a https://github.com/FirebirdSQL/firebird-documentation/commit/2bb1540c17ca4523144124d7a9c6e5b89f1ffd6a Author: Mark Rotteveel Date: 2020-07-01 (Wed, 01 Jul 2020) Changed paths: M src/docs/asciidoc/de/firebirddocs/fbcache/firebird-cache-de.adoc M src/docs/asciidoc/de/firebirddocs/generatorguide/firebird-generatoren-ratgeber.adoc M src/docs/asciidoc/de/refdocs/fblangref25/firebird-25-sprachreferenz.adoc A src/docs/asciidoc/en/firebirddocs/fbmetasecur/firebird-metadata-security.adoc M src/docs/asciidoc/fb-docs-redirects.txt A src/docs/asciidoc/pt_BR/attributes-pt_BR.adoc A src/docs/asciidoc/pt_BR/firebirddocs/fbmetasecur/firebird-metadata-security-pt_br.adoc A src/docs/asciidoc/ru/firebirddocs/fbmetasecur/firebird-metadata-security-ru.adoc M src/docs/asciidoc/ru/firebirddocs/generatorguide/firebird-generator-guide-ru.adoc R src/docs/firebirddocs-pt_br/fbmetasecur-pt_br.xml M src/docs/firebirddocs-pt_br/firebirddocs-pt_br.xml R src/docs/firebirddocs-ru/fbmetasecur-ru.xml M src/docs/firebirddocs-ru/firebirddocs-ru.xml R src/docs/firebirddocs/fbmetasecur.xml M src/docs/firebirddocs/firebirddocs.xml Log Message: --- Migrate fbmetasecur.xml, fbmetasecur-pt_br.xml, fbmetasecur.xml to AsciiDoc Fix issue with translation of 'Table of Contents' not being used ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] Firebird File and Metadata Security migrated
Hello, I think a large table of contents makes sense. Even I find it difficult to find documents sometimes. How should a newcomer know in which area a document is or that it exists at all. That's why I prefer a single large table of contents. Regards Martin ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] Firebird File and Metadata Security migrated
Hello, I support the idea of the single Page list/index for all docs. I suggest that we should create such page, and then ask people about their opinion (it will also increase awareness of documentation). Regards, Alexey Kovyazin ср, 1 июл. 2020 г., 16:31 Paul Vinkenoog : > Mark Rotteveel wrote: > > > I migrated the Firebird File and Metadata Security document. > (...) > > I do wonder if this document really belongs under 'Reference Manuals', I > > think it would be more suitable under White Papers & Presentations.. > > I think the whole categorization is seriously flawed. > > First we have the top-level categories: > > - Release Notes > - Reference Manuals > - White Papers & Presentations > - FAQ > - Firebird Books > - Drivers Documentation > - Third-Party Docs and Articles > > each corresponding to a separate webpage. > > Then within those categories (i.e. on most of those webpages) we have > further subdivisions. For the page "Reference Manuals", they are: > > - Current Versions > - Firebird Command Line Tools > - Various User Manuals > - Reference Material (h? I thought the whole page was Reference > Manuals) > - Firebird Licenses > > and a couple more. > > Given the fact that the bulk of our docs is on the "Reference Manuals" > page, even if they aren't reference manuals, I think that the Firebird > File and Metadata Security document is reasonably well placed under > "Various User Manuals". > > Now, this isn't a pressing matter, but I do think that we should have > the Doc index back on a single page again (except maybe for a few docs/ > categories that are heavily "niche" and/or outdated and/or third-party), > with categories that make sense, and without separate lines for each > language version, because that's eating up huge amounts of vertical > space. > > Paul Vinkenoog > > > ___ > Firebird-docs mailing list > Firebird-docs@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/firebird-docs > ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
[Firebird-docs] [FirebirdSQL/firebird-documentation] d07fd6: Added German translation of nbackup. Needs some wo...
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: d07fd69be29e427f5ecc742ecfcd2877c74923db https://github.com/FirebirdSQL/firebird-documentation/commit/d07fd69be29e427f5ecc742ecfcd2877c74923db Author: Martin Köditz Date: 2020-07-01 (Wed, 01 Jul 2020) Changed paths: A src/docs/asciidoc/de/firebirddocs/nbackup/firebird-nbackup-de.adoc Log Message: --- Added German translation of nbackup. Needs some work before publishing. ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] Firebird File and Metadata Security migrated
Mark Rotteveel wrote: > I migrated the Firebird File and Metadata Security document. (...) > I do wonder if this document really belongs under 'Reference Manuals', I > think it would be more suitable under White Papers & Presentations.. I think the whole categorization is seriously flawed. First we have the top-level categories: - Release Notes - Reference Manuals - White Papers & Presentations - FAQ - Firebird Books - Drivers Documentation - Third-Party Docs and Articles each corresponding to a separate webpage. Then within those categories (i.e. on most of those webpages) we have further subdivisions. For the page "Reference Manuals", they are: - Current Versions - Firebird Command Line Tools - Various User Manuals - Reference Material (h? I thought the whole page was Reference Manuals) - Firebird Licenses and a couple more. Given the fact that the bulk of our docs is on the "Reference Manuals" page, even if they aren't reference manuals, I think that the Firebird File and Metadata Security document is reasonably well placed under "Various User Manuals". Now, this isn't a pressing matter, but I do think that we should have the Doc index back on a single page again (except maybe for a few docs/ categories that are heavily "niche" and/or outdated and/or third-party), with categories that make sense, and without separate lines for each language version, because that's eating up huge amounts of vertical space. Paul Vinkenoog ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
