Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 20-01-2020 19:25, Paul Vinkenoog wrote: Mark wrote: Also, at lines 320-324 (that's the bit about how we used to keep tools and lib binaries in the CVS repository): you've changed that to 'git repository', but of course they were never in there. Technically they are in the git repository as well, as I preserved the history during migration, but I get your point ;) Ah, OK -- it's always good to be precise! :-) I'll do a revision to remove that and then merge. Good, thanks again! I have released the modified docs to the website. Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
Mark wrote: > > Also, at lines 320-324 (that's the bit about how we used to keep tools and > > lib binaries in the CVS repository): you've changed that to 'git > > repository', > > but of course they were never in there. > > Technically they are in the git repository as well, as I preserved the > history during migration, but I get your point ;) Ah, OK -- it's always good to be precise! :-) > I'll do a revision to remove that and then merge. Good, thanks again! Cheers, Paul ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 20-01-2020 15:45, Paul Vinkenoog wrote: Hi Mark, I have created a pull request with some changes: https://github.com/FirebirdSQL/firebird-documentation/pull/10 I would really like a second pair of eyes on this, otherwise I will merge and release this next weekend. Looks very good to me, but I'm still a git newbie so any git-technical errors may have eluded me. Also, at lines 320-324 (that's the bit about how we used to keep tools and lib binaries in the CVS repository): you've changed that to 'git repository', but of course they were never in there. Technically they are in the git repository as well, as I preserved the history during migration, but I get your point ;) More importantly, this has become useless information. Nobody cares - or should care - where we kept those binaries in a distant past. So I would cut away most of this section and just make sure that they can find them now. That is, keep the lines pointing the reader to the readmes. I'll do a revision to remove that and then merge. Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
Hi Mark, > > I have created a pull request with some changes: > > https://github.com/FirebirdSQL/firebird-documentation/pull/10 > > I would really like a second pair of eyes on this, otherwise I will > merge and release this next weekend. Looks very good to me, but I'm still a git newbie so any git-technical errors may have eluded me. Also, at lines 320-324 (that's the bit about how we used to keep tools and lib binaries in the CVS repository): you've changed that to 'git repository', but of course they were never in there. More importantly, this has become useless information. Nobody cares - or should care - where we kept those binaries in a distant past. So I would cut away most of this section and just make sure that they can find them now. That is, keep the lines pointing the reader to the readmes. Thanks for the work you're doing on the documentation! Cheers, Paul ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 11-01-2020 12:49, Mark Rotteveel wrote: On 08/01/2020 10:19, marius adrian popa wrote: docbuilding doc needs some updates after CVS -> Github switch https://github.com/FirebirdSQL/firebird-documentation/blob/master/src/docs/firebirddocs/docbuilding-howto.xml I have created a pull request with some changes: https://github.com/FirebirdSQL/firebird-documentation/pull/10 I would really like a second pair of eyes on this, otherwise I will merge and release this next weekend. I found it hard to write a to-the-point usage instruction for git. I use git daily, and even though I'm far from an expert, I find the basic usage trivial but I noticed that I find it hard to write scenarios for someone new to git, especially without going too deep too fast.. I have kept it limited, and pointed to GitHub documentation for more information. However, I think the current description should get someone started, but I don't think they demonstrate the power of git well, nor do they describe a good work-flow with git. I think it might be good if someone revises them. Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 11/01/2020 12:49, Mark Rotteveel wrote: On 08/01/2020 10:19, marius adrian popa wrote: docbuilding doc needs some updates after CVS -> Github switch https://github.com/FirebirdSQL/firebird-documentation/blob/master/src/docs/firebirddocs/docbuilding-howto.xml I have created a pull request with some changes: https://github.com/FirebirdSQL/firebird-documentation/pull/10 I found it hard to write a to-the-point usage instruction for git. I use git daily, and even though I'm far from an expert, I find the basic usage trivial but I noticed that I find it hard to write scenarios for someone new to git, especially without going too deep too fast.. I have kept it limited, and pointed to GitHub documentation for more information. However, I think the current description should get someone started, but I don't think they demonstrate the power of git well, nor do they describe a good work-flow with git. I think it might be good if someone revises them. Alternatively, we should consider whether git usage instructions even belong in this type of documentation. Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 08/01/2020 10:19, marius adrian popa wrote: docbuilding doc needs some updates after CVS -> Github switch https://github.com/FirebirdSQL/firebird-documentation/blob/master/src/docs/firebirddocs/docbuilding-howto.xml I have created a pull request with some changes: https://github.com/FirebirdSQL/firebird-documentation/pull/10 I found it hard to write a to-the-point usage instruction for git. I use git daily, and even though I'm far from an expert, I find the basic usage trivial but I noticed that I find it hard to write scenarios for someone new to git, especially without going too deep too fast.. I have kept it limited, and pointed to GitHub documentation for more information. However, I think the current description should get someone started, but I don't think they demonstrate the power of git well, nor do they describe a good work-flow with git. I think it might be good if someone revises them. Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
Re: [Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
On 2020-01-08 10:19, marius adrian popa wrote: docbuilding doc needs some updates after CVS -> Github switch https://github.com/FirebirdSQL/firebird-documentation/blob/master/src/docs/firebirddocs/docbuilding-howto.xml I'll take a look this weekend. However, it would be very helpful if you could point out which parts need updating in your opinion. Mark ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
[Firebird-docs] docbuilding doc needs some updates after CVS -> Github switch
docbuilding doc needs some updates after CVS -> Github switch https://github.com/FirebirdSQL/firebird-documentation/blob/master/src/docs/firebirddocs/docbuilding-howto.xml ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs