Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On Fri, Apr 6, 2018 at 8:30 AM, Emil Velikovwrote: > On 6 April 2018 at 10:40, Daniel Stone wrote: >> Hi all, >> >> On 5 April 2018 at 23:55, Laura Ekstrand wrote: >>> So I spoke with Daniel Stone today about the infrastructure. He estimates >>> it will be ready to deploy the website in 2-3 weeks, at the most. So I'd >>> say the infrastructure will be there when we are ready. >>> >>> In the new system, our website will be running in its own container managed >>> by freedesktop's new Gitlab server. So what we need to do for the deploy is: >> >> Right. We can't keep stacking random unmanaged bits for every project >> into unconfined spaces, not least as it makes upgrades super painful. >> What we want to do is use GitLab's CI mechanism to automatically run a >> pipeline to generate the static pages, and likely serve them from >> GitLab Pages. Having it all done in containers means that you can be >> in complete control of the environment without having to block on >> admins, and it's also easier for others to reproduce. >> >>> 1. Fork mesa into a repo on Gitlab.com (https://gitlab.freedesktop.org). >> >> This should be actual gitlab.com for now. I don't have CI enabled on >> gitlab.fd.o yet as it's surprisingly difficult to do without exposing >> root to everyone. I'm aiming for the next couple of weeks to have this >> done. I'll ping this thread when it is up. >> > Thanks for the confirmation and the work Dan. > > Some time back I looked how lxc manages its containers w/o root. I > could help out porting that to docker/others. > > Laura, others, > > As you can see things are not finalised nor official*, yet. Hence why > I would not rush into rewriting the docs/website. Otherwise the work > would be sit in a branch, again :-\ > drive-by comment but would pointing mesa3d.org at mesa3d.readthedocs.org, or something like that, suffice as a temporary solution, if needed? BR, -R > HTH > Emil > * Did anyone mention gitlab to the folks who are not on IRC? > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 6 April 2018 at 10:40, Daniel Stonewrote: > Hi all, > > On 5 April 2018 at 23:55, Laura Ekstrand wrote: >> So I spoke with Daniel Stone today about the infrastructure. He estimates >> it will be ready to deploy the website in 2-3 weeks, at the most. So I'd >> say the infrastructure will be there when we are ready. >> >> In the new system, our website will be running in its own container managed >> by freedesktop's new Gitlab server. So what we need to do for the deploy is: > > Right. We can't keep stacking random unmanaged bits for every project > into unconfined spaces, not least as it makes upgrades super painful. > What we want to do is use GitLab's CI mechanism to automatically run a > pipeline to generate the static pages, and likely serve them from > GitLab Pages. Having it all done in containers means that you can be > in complete control of the environment without having to block on > admins, and it's also easier for others to reproduce. > >> 1. Fork mesa into a repo on Gitlab.com (https://gitlab.freedesktop.org). > > This should be actual gitlab.com for now. I don't have CI enabled on > gitlab.fd.o yet as it's surprisingly difficult to do without exposing > root to everyone. I'm aiming for the next couple of weeks to have this > done. I'll ping this thread when it is up. > Thanks for the confirmation and the work Dan. Some time back I looked how lxc manages its containers w/o root. I could help out porting that to docker/others. Laura, others, As you can see things are not finalised nor official*, yet. Hence why I would not rush into rewriting the docs/website. Otherwise the work would be sit in a branch, again :-\ HTH Emil * Did anyone mention gitlab to the folks who are not on IRC? ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi all, On 5 April 2018 at 23:55, Laura Ekstrandwrote: > So I spoke with Daniel Stone today about the infrastructure. He estimates > it will be ready to deploy the website in 2-3 weeks, at the most. So I'd > say the infrastructure will be there when we are ready. > > In the new system, our website will be running in its own container managed > by freedesktop's new Gitlab server. So what we need to do for the deploy is: Right. We can't keep stacking random unmanaged bits for every project into unconfined spaces, not least as it makes upgrades super painful. What we want to do is use GitLab's CI mechanism to automatically run a pipeline to generate the static pages, and likely serve them from GitLab Pages. Having it all done in containers means that you can be in complete control of the environment without having to block on admins, and it's also easier for others to reproduce. > 1. Fork mesa into a repo on Gitlab.com (https://gitlab.freedesktop.org). This should be actual gitlab.com for now. I don't have CI enabled on gitlab.fd.o yet as it's surprisingly difficult to do without exposing root to everyone. I'm aiming for the next couple of weeks to have this done. I'll ping this thread when it is up. Cheers, Daniel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
So I spoke with Daniel Stone today about the infrastructure. He estimates it will be ready to deploy the website in 2-3 weeks, at the most. So I'd say the infrastructure will be there when we are ready. In the new system, our website will be running in its own container managed by freedesktop's new Gitlab server. So what we need to do for the deploy is: 1. Fork mesa into a repo on Gitlab.com (https://gitlab.freedesktop.org). 2. Create a .gitlab-ci.yml file which compiles the website from the files. (https://docs.gitlab.com/ee/ci/yaml/). In order to get the files ready, we need to make sure that they are rebased on top of Mesa master and reviewed. I started rebasing here: https://cgit.freedesktop.org/~ldeks/mesa?h=website2. That preserves the git history well, but if it's not a big deal to everyone else, we could just rebase Jean's branch. I don't think much has changed. Thanks. Laura On Thu, Apr 5, 2018 at 11:18 AM, Emil Velikovwrote: > On 5 April 2018 at 19:10, Laura Ekstrand wrote: > > Emil, > > > > Specifically, what infrastructure do you need? Gallium is already > carrying > > Sphinx around as a dependency. > > > The gallium docs are hosted on readthedocs.org. And I doubt we want to > move the main mesa3d.org website there ;-) > Currently mesa3d.org, most graphics stuff and others are on > freedesktop.org infrastructure. > > HTH > Emil > P.S. Can I buy you to use interleaved posting/plain text email, please? > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 5 April 2018 at 19:10, Laura Ekstrandwrote: > Emil, > > Specifically, what infrastructure do you need? Gallium is already carrying > Sphinx around as a dependency. > The gallium docs are hosted on readthedocs.org. And I doubt we want to move the main mesa3d.org website there ;-) Currently mesa3d.org, most graphics stuff and others are on freedesktop.org infrastructure. HTH Emil P.S. Can I buy you to use interleaved posting/plain text email, please? ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Emil, Specifically, what infrastructure do you need? Gallium is already carrying Sphinx around as a dependency. Laura On Thu, Apr 5, 2018 at 11:07 AM, Emil Velikovwrote: > Hi everyone, > > On 5 April 2018 at 01:58, Laura Ekstrand wrote: > > I forgot to note that you have to choose space->ignore in the diff > options > > on cgit in order to see the easy-to-read git diff. > > > I really should have made this more obvious. The key blocker isn't > about reviewing the patches, but having the required infra to deploy > it. > > Eric E, was planning to look that up, although ETIME and potential > gitlab move got in the way. > I'm not sure how we're doing on the latter, but I'm hoping that we > would be soon. > > HTH > Emil > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi everyone, On 5 April 2018 at 01:58, Laura Ekstrandwrote: > I forgot to note that you have to choose space->ignore in the diff options > on cgit in order to see the easy-to-read git diff. > I really should have made this more obvious. The key blocker isn't about reviewing the patches, but having the required infra to deploy it. Eric E, was planning to look that up, although ETIME and potential gitlab move got in the way. I'm not sure how we're doing on the latter, but I'm hoping that we would be soon. HTH Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
I forgot to note that you have to choose space->ignore in the diff options on cgit in order to see the easy-to-read git diff. On Wed, Apr 4, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net> wrote: > Jean, > > The main problem is not the conversion to rst. It's preserving the git > history so that the patches are easily reviewable. > > I've started a branch here: https://cgit.freedesktop.org/~ > ldeks/mesa?h=website2. You see that the git diff shows me that the text > of the website hasn't changed at all? > > I will probably squish the rename commits together at some point. But the > format changes have to be in separate patches so git recognizes that the > text of the website hasn't really changed. > > Thanks. > > Laura > > On Tue, Apr 3, 2018 at 1:36 PM, Jean Hertel <jean.her...@hotmail.com> > wrote: > >> Hi Laura, >> >> >> Aurelio Silves pointed me out that there is the possibility of using >> pandoc for the conversion of mesa html sources to rst. >> >> You can take a look here: https://pandoc.org/index.html >> >> Depending on your distribution, probably there is a package for this. >> >> >> Also, if there is anything else I can do, send me an email and I will do >> the best I can to help. >> >> Kind Regards, >> >> Jean Hertel >> >> >> -- >> *De:* Jean Hertel <jean.her...@hotmail.com> >> *Enviado:* segunda-feira, 2 de abril de 2018 21:19 >> *Para:* Laura Ekstrand >> >> *Cc:* Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; >> Jason Ekstrand >> *Assunto:* Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx >> >> Hi Laura, >> >> I haven't used any script. >> I made all the HTML to rst translations by hand, file by file. >> >> Kind Regards, >> Jean Hertel >> >> Em 2 de abril de 2018 19:09:34 BRT, Laura Ekstrand <la...@jlekstrand.net> >> escreveu: >> >> Hi Jean, >> >> I'm going to play around with your patches to get them into a format that >> Mesa devs can review. This will blow the history away. >> >> The problem is that your workflow in 1 & 2 ruins the Git history for >> reviewers. It makes the patch series hard to read. >> >> Could you provide us with your script for translating HTML to rst? Go >> ahead and commit it to your repo as a patch. >> >> Thanks. >> >> Laura >> >> On Sun, Apr 1, 2018 at 6:12 AM, Jean Hertel <jean.her...@hotmail.com> >> wrote: >> >> Hi Laura, >> >> >> The commits have the idea of being atomic, so it makes sense to have a >> lot of them. >> >> Some of them are just fixes, and can be squashed. >> >> >> Please keep in mind that no CSS file is supposed to live there, as we are >> using an existing template from readTheDocs. >> >> The commits are doing mainly two things: >> >> 1 - Create a new file and translate the old HTML content into a rst >> format. >> >> 2 - Delete the old file >> >> Kind Regards, >> >> Jean Hertel >> >> -- >> *De:* Laura Ekstrand <la...@jlekstrand.net> >> *Enviado:* sábado, 31 de março de 2018 22:06 >> *Para:* Jean Hertel >> *Cc:* Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; >> Jason Ekstrand >> *Assunto:* Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx >> >> Jean, >> >> I've taken at look at your sphinx-docs branch ( >> https://github.com/jlHertel/mesa). >> >> Oh my you have a lot of commits there! It would be simpler for me to >> review if you could squash some of them together. >> >> I am thinking a series on the order of 30 patches to start - just the >> pretty CSS stuff in Sphinx. >> >> Once we get the page to look nicer, then we can start editing the content >> for readability!!! >> >> Thanks. >> >> Laura >> >> On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net> >> wrote: >> >> Hello Jean, >> >> Has anyone reviewed your patch series yet? I would like to get these >> website updates moving. >> >> Thanks. >> >> Laura >> >> On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com> >> wrote: >> >> Hello Emil, >> >> I've updated the website with the new release notes template. >> >> Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html >> >> >> What about rebasing my current work on top of mesa-master? >> (Remembering that github comments referencing directly the commit will be >> loss) >> >> >> The repository: https://github.com/jlHertel/mesa >> Demo site: http://mesa2.jeanhertel.com.br/ >> >> Best regards, >> Jean Hertel >> ___ >> mesa-dev mailing list >> mesa-dev@lists.freedesktop.org >> https://lists.freedesktop.org/mailman/listinfo/mesa-dev >> >> >> >> >> >> -- >> Enviado de meu dispositivo Android com K-9 mail. Desculpe-me pela >> brevidade. >> > > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Jean, The main problem is not the conversion to rst. It's preserving the git history so that the patches are easily reviewable. I've started a branch here: https://cgit.freedesktop.org/~ldeks/mesa?h=website2. You see that the git diff shows me that the text of the website hasn't changed at all? I will probably squish the rename commits together at some point. But the format changes have to be in separate patches so git recognizes that the text of the website hasn't really changed. Thanks. Laura On Tue, Apr 3, 2018 at 1:36 PM, Jean Hertel <jean.her...@hotmail.com> wrote: > Hi Laura, > > > Aurelio Silves pointed me out that there is the possibility of using > pandoc for the conversion of mesa html sources to rst. > > You can take a look here: https://pandoc.org/index.html > > Depending on your distribution, probably there is a package for this. > > > Also, if there is anything else I can do, send me an email and I will do > the best I can to help. > > Kind Regards, > > Jean Hertel > > > -- > *De:* Jean Hertel <jean.her...@hotmail.com> > *Enviado:* segunda-feira, 2 de abril de 2018 21:19 > *Para:* Laura Ekstrand > > *Cc:* Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason > Ekstrand > *Assunto:* Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx > > Hi Laura, > > I haven't used any script. > I made all the HTML to rst translations by hand, file by file. > > Kind Regards, > Jean Hertel > > Em 2 de abril de 2018 19:09:34 BRT, Laura Ekstrand <la...@jlekstrand.net> > escreveu: > > Hi Jean, > > I'm going to play around with your patches to get them into a format that > Mesa devs can review. This will blow the history away. > > The problem is that your workflow in 1 & 2 ruins the Git history for > reviewers. It makes the patch series hard to read. > > Could you provide us with your script for translating HTML to rst? Go > ahead and commit it to your repo as a patch. > > Thanks. > > Laura > > On Sun, Apr 1, 2018 at 6:12 AM, Jean Hertel <jean.her...@hotmail.com> > wrote: > > Hi Laura, > > > The commits have the idea of being atomic, so it makes sense to have a lot > of them. > > Some of them are just fixes, and can be squashed. > > > Please keep in mind that no CSS file is supposed to live there, as we are > using an existing template from readTheDocs. > > The commits are doing mainly two things: > > 1 - Create a new file and translate the old HTML content into a rst format. > > 2 - Delete the old file > > Kind Regards, > > Jean Hertel > > ---------- > *De:* Laura Ekstrand <la...@jlekstrand.net> > *Enviado:* sábado, 31 de março de 2018 22:06 > *Para:* Jean Hertel > *Cc:* Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason > Ekstrand > *Assunto:* Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx > > Jean, > > I've taken at look at your sphinx-docs branch ( > https://github.com/jlHertel/mesa). > > Oh my you have a lot of commits there! It would be simpler for me to > review if you could squash some of them together. > > I am thinking a series on the order of 30 patches to start - just the > pretty CSS stuff in Sphinx. > > Once we get the page to look nicer, then we can start editing the content > for readability!!! > > Thanks. > > Laura > > On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net> > wrote: > > Hello Jean, > > Has anyone reviewed your patch series yet? I would like to get these > website updates moving. > > Thanks. > > Laura > > On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com> > wrote: > > Hello Emil, > > I've updated the website with the new release notes template. > > Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html > > > What about rebasing my current work on top of mesa-master? > (Remembering that github comments referencing directly the commit will be > loss) > > > The repository: https://github.com/jlHertel/mesa > Demo site: http://mesa2.jeanhertel.com.br/ > > Best regards, > Jean Hertel > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > > > > > > -- > Enviado de meu dispositivo Android com K-9 mail. Desculpe-me pela > brevidade. > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi Laura, Aurelio Silves pointed me out that there is the possibility of using pandoc for the conversion of mesa html sources to rst. You can take a look here: https://pandoc.org/index.html Depending on your distribution, probably there is a package for this. Also, if there is anything else I can do, send me an email and I will do the best I can to help. Kind Regards, Jean Hertel De: Jean Hertel <jean.her...@hotmail.com> Enviado: segunda-feira, 2 de abril de 2018 21:19 Para: Laura Ekstrand Cc: Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason Ekstrand Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx Hi Laura, I haven't used any script. I made all the HTML to rst translations by hand, file by file. Kind Regards, Jean Hertel Em 2 de abril de 2018 19:09:34 BRT, Laura Ekstrand <la...@jlekstrand.net> escreveu: Hi Jean, I'm going to play around with your patches to get them into a format that Mesa devs can review. This will blow the history away. The problem is that your workflow in 1 & 2 ruins the Git history for reviewers. It makes the patch series hard to read. Could you provide us with your script for translating HTML to rst? Go ahead and commit it to your repo as a patch. Thanks. Laura On Sun, Apr 1, 2018 at 6:12 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hi Laura, The commits have the idea of being atomic, so it makes sense to have a lot of them. Some of them are just fixes, and can be squashed. Please keep in mind that no CSS file is supposed to live there, as we are using an existing template from readTheDocs. The commits are doing mainly two things: 1 - Create a new file and translate the old HTML content into a rst format. 2 - Delete the old file Kind Regards, Jean Hertel De: Laura Ekstrand <la...@jlekstrand.net<mailto:la...@jlekstrand.net>> Enviado: sábado, 31 de março de 2018 22:06 Para: Jean Hertel Cc: Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org>; Jason Ekstrand Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx Jean, I've taken at look at your sphinx-docs branch (https://github.com/jlHertel/mesa). Oh my you have a lot of commits there! It would be simpler for me to review if you could squash some of them together. I am thinking a series on the order of 30 patches to start - just the pretty CSS stuff in Sphinx. Once we get the page to look nicer, then we can start editing the content for readability!!! Thanks. Laura On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net<mailto:la...@jlekstrand.net>> wrote: Hello Jean, Has anyone reviewed your patch series yet? I would like to get these website updates moving. Thanks. Laura On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hello Emil, I've updated the website with the new release notes template. Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html What about rebasing my current work on top of mesa-master? (Remembering that github comments referencing directly the commit will be loss) The repository: https://github.com/jlHertel/mesa Demo site: http://mesa2.jeanhertel.com.br/ Best regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org> https://lists.freedesktop.org/mailman/listinfo/mesa-dev -- Enviado de meu dispositivo Android com K-9 mail. Desculpe-me pela brevidade. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi Laura, I haven't used any script. I made all the HTML to rst translations by hand, file by file. Kind Regards, Jean Hertel Em 2 de abril de 2018 19:09:34 BRT, Laura Ekstrand <la...@jlekstrand.net> escreveu: Hi Jean, I'm going to play around with your patches to get them into a format that Mesa devs can review. This will blow the history away. The problem is that your workflow in 1 & 2 ruins the Git history for reviewers. It makes the patch series hard to read. Could you provide us with your script for translating HTML to rst? Go ahead and commit it to your repo as a patch. Thanks. Laura On Sun, Apr 1, 2018 at 6:12 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hi Laura, The commits have the idea of being atomic, so it makes sense to have a lot of them. Some of them are just fixes, and can be squashed. Please keep in mind that no CSS file is supposed to live there, as we are using an existing template from readTheDocs. The commits are doing mainly two things: 1 - Create a new file and translate the old HTML content into a rst format. 2 - Delete the old file Kind Regards, Jean Hertel De: Laura Ekstrand <la...@jlekstrand.net<mailto:la...@jlekstrand.net>> Enviado: sábado, 31 de março de 2018 22:06 Para: Jean Hertel Cc: Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org>; Jason Ekstrand Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx Jean, I've taken at look at your sphinx-docs branch (https://github.com/jlHertel/mesa). Oh my you have a lot of commits there! It would be simpler for me to review if you could squash some of them together. I am thinking a series on the order of 30 patches to start - just the pretty CSS stuff in Sphinx. Once we get the page to look nicer, then we can start editing the content for readability!!! Thanks. Laura On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net<mailto:la...@jlekstrand.net>> wrote: Hello Jean, Has anyone reviewed your patch series yet? I would like to get these website updates moving. Thanks. Laura On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hello Emil, I've updated the website with the new release notes template. Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html What about rebasing my current work on top of mesa-master? (Remembering that github comments referencing directly the commit will be loss) The repository: https://github.com/jlHertel/mesa Demo site: http://mesa2.jeanhertel.com.br/ Best regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org> https://lists.freedesktop.org/mailman/listinfo/mesa-dev -- Enviado de meu dispositivo Android com K-9 mail. Desculpe-me pela brevidade. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi Jean, I'm going to play around with your patches to get them into a format that Mesa devs can review. This will blow the history away. The problem is that your workflow in 1 & 2 ruins the Git history for reviewers. It makes the patch series hard to read. Could you provide us with your script for translating HTML to rst? Go ahead and commit it to your repo as a patch. Thanks. Laura On Sun, Apr 1, 2018 at 6:12 AM, Jean Hertel <jean.her...@hotmail.com> wrote: > Hi Laura, > > > The commits have the idea of being atomic, so it makes sense to have a lot > of them. > > Some of them are just fixes, and can be squashed. > > > Please keep in mind that no CSS file is supposed to live there, as we are > using an existing template from readTheDocs. > > The commits are doing mainly two things: > > 1 - Create a new file and translate the old HTML content into a rst format. > > 2 - Delete the old file > > Kind Regards, > > Jean Hertel > > -- > *De:* Laura Ekstrand <la...@jlekstrand.net> > *Enviado:* sábado, 31 de março de 2018 22:06 > *Para:* Jean Hertel > *Cc:* Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason > Ekstrand > *Assunto:* Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx > > Jean, > > I've taken at look at your sphinx-docs branch ( > https://github.com/jlHertel/mesa). > > Oh my you have a lot of commits there! It would be simpler for me to > review if you could squash some of them together. > > I am thinking a series on the order of 30 patches to start - just the > pretty CSS stuff in Sphinx. > > Once we get the page to look nicer, then we can start editing the content > for readability!!! > > Thanks. > > Laura > > On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net> > wrote: > > Hello Jean, > > Has anyone reviewed your patch series yet? I would like to get these > website updates moving. > > Thanks. > > Laura > > On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com> > wrote: > > Hello Emil, > > I've updated the website with the new release notes template. > > Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html > > > What about rebasing my current work on top of mesa-master? > (Remembering that github comments referencing directly the commit will be > loss) > > > The repository: https://github.com/jlHertel/mesa > Demo site: http://mesa2.jeanhertel.com.br/ > > Best regards, > Jean Hertel > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > > > > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi Laura, The commits have the idea of being atomic, so it makes sense to have a lot of them. Some of them are just fixes, and can be squashed. Please keep in mind that no CSS file is supposed to live there, as we are using an existing template from readTheDocs. The commits are doing mainly two things: 1 - Create a new file and translate the old HTML content into a rst format. 2 - Delete the old file Kind Regards, Jean Hertel De: Laura Ekstrand <la...@jlekstrand.net> Enviado: sábado, 31 de março de 2018 22:06 Para: Jean Hertel Cc: Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason Ekstrand Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx Jean, I've taken at look at your sphinx-docs branch (https://github.com/jlHertel/mesa). Oh my you have a lot of commits there! It would be simpler for me to review if you could squash some of them together. I am thinking a series on the order of 30 patches to start - just the pretty CSS stuff in Sphinx. Once we get the page to look nicer, then we can start editing the content for readability!!! Thanks. Laura On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrand <la...@jlekstrand.net<mailto:la...@jlekstrand.net>> wrote: Hello Jean, Has anyone reviewed your patch series yet? I would like to get these website updates moving. Thanks. Laura On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hello Emil, I've updated the website with the new release notes template. Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html What about rebasing my current work on top of mesa-master? (Remembering that github comments referencing directly the commit will be loss) The repository: https://github.com/jlHertel/mesa Demo site: http://mesa2.jeanhertel.com.br/ Best regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org> https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hi Laura, Unfortunately this repository was not reviewed. It is already one year old, so its pretty outdated now. If you are able to get enough people to review it, I can of course update it to mesa-git. Kind Regards, Jean Hertel De: Laura Ekstrand <la...@jlekstrand.net> Enviado: sábado, 31 de março de 2018 21:57 Para: Jean Hertel Cc: Emil Velikov; Vedran Miletić; mesa-dev@lists.freedesktop.org; Jason Ekstrand Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx Hello Jean, Has anyone reviewed your patch series yet? I would like to get these website updates moving. Thanks. Laura On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel <jean.her...@hotmail.com<mailto:jean.her...@hotmail.com>> wrote: Hello Emil, I've updated the website with the new release notes template. Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html What about rebasing my current work on top of mesa-master? (Remembering that github comments referencing directly the commit will be loss) The repository: https://github.com/jlHertel/mesa Demo site: http://mesa2.jeanhertel.com.br/ Best regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org<mailto:mesa-dev@lists.freedesktop.org> https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Jean, I've taken at look at your sphinx-docs branch (https://github.com/jlHertel/mesa). Oh my you have a lot of commits there! It would be simpler for me to review if you could squash some of them together. I am thinking a series on the order of 30 patches to start - just the pretty CSS stuff in Sphinx. Once we get the page to look nicer, then we can start editing the content for readability!!! Thanks. Laura On Sat, Mar 31, 2018 at 5:57 PM, Laura Ekstrandwrote: > Hello Jean, > > Has anyone reviewed your patch series yet? I would like to get these > website updates moving. > > Thanks. > > Laura > > On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertel > wrote: > >> Hello Emil, >> >> I've updated the website with the new release notes template. >> >> Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html >> >> >> What about rebasing my current work on top of mesa-master? >> (Remembering that github comments referencing directly the commit will be >> loss) >> >> >> The repository: https://github.com/jlHertel/mesa >> Demo site: http://mesa2.jeanhertel.com.br/ >> >> Best regards, >> Jean Hertel >> ___ >> mesa-dev mailing list >> mesa-dev@lists.freedesktop.org >> https://lists.freedesktop.org/mailman/listinfo/mesa-dev >> > > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hello Jean, Has anyone reviewed your patch series yet? I would like to get these website updates moving. Thanks. Laura On Tue, Jun 6, 2017 at 10:43 AM, Jean Hertelwrote: > Hello Emil, > > I've updated the website with the new release notes template. > > Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html > > > What about rebasing my current work on top of mesa-master? > (Remembering that github comments referencing directly the commit will be > loss) > > > The repository: https://github.com/jlHertel/mesa > Demo site: http://mesa2.jeanhertel.com.br/ > > Best regards, > Jean Hertel > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hello Emil, I've updated the website with the new release notes template. Please take a look at: http://mesa2.jeanhertel.com.br/relnotes.html What about rebasing my current work on top of mesa-master? (Remembering that github comments referencing directly the commit will be loss) The repository: https://github.com/jlHertel/mesa Demo site: http://mesa2.jeanhertel.com.br/ Best regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
From: Emil VelikovSended: 24 May 2017 04:53 >I was looking at it yesterday, and should have most of it done some time today. > >The TOC "...release notes" solution (as illustrated by the 17.0.4 >ones) seem fine, so until we come with a better idea I'll just go with >it. > >-Emil OK, I will update the remaining release notes with the proposed solution used in the 17.0.4; One more question: Currently we have many new changes to the documentation in mesa master (like the new releases). Should I rebase and port those to Sphinx too? I'm asking because, if I rebase, the comments made on github will be lost. Best Regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 23 May 2017 at 11:50, Jean Hertelwrote: > Hello, > > Any update on this? > Is someone validating the github repository? > I was looking at it yesterday, and should have most of it done some time today. The TOC "...release notes" solution (as illustrated by the 17.0.4 ones) seem fine, so until we come with a better idea I'll just go with it. -Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hello, Any update on this? Is someone validating the github repository? Thanks in advance. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Any throughts on this? Emil, Did you have time to check the page I mentioned? Best Regards, Jean Hertel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
>On 2017-04-26 at 10:32, Emil Velikovwrote: >No worries - we can always change/polish the theme as needed. >Just checking that there's nothing 'fundamentally broken' there. It's already fixed. Check the repo and the live demo. >Right - I was skimming through 4.1 where the spacing in the number >lists is still funky. >Either way I'm not saying that we should throw your work there. Just >that those will need closer look (read will take more time) than their >HTML brethren. I will have a look there and see what can be improved. >To visualise what I'm talking about observe the TOC as you open any of >the [HTML] release notes. >Replacing the second "Mesa ... release notes$date" with something >like above would be great, but optional. What a shame, I haven't seen this before. I will update to a new format. Before I make any change, I've manually changed just one file[1] Can you check it and see if its OK now? If not, please leave a comment and more suggestions :) [1]: http://mesa2.jeanhertel.com.br/relnotes/17.0.4.html ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
>On 2017-04-26 at 10:32, Emil Velikovwrote: >>>Thanks again for doing this Jean. A handful of, mostly trivial, questions. >>> >>> - Is there a website where one can check the output of specific >>>Sphinx markdown. >> >> I have searched for such a thing too, but have not found :( >> >:-( A quick note: Aurelio Silver sent me an email right now with an online editor[1]. It seems very good for me. [1]: https://livesphinx.herokuapp.com/ ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 2017-04-26 at 10:32, Emil Velikovwrote: No worries - we can always change/polish the theme as needed. Just checking that there's nothing 'fundamentally broken' there. It's already fixed. Check the repo and the live demo. Right - I was skimming through 4.1 where the spacing in the number lists is still funky. Either way I'm not saying that we should throw your work there. Just that those will need closer look (read will take more time) than their HTML brethren. I will have a look there and see what can be improved. To visualise what I'm talking about observe the TOC as you open any of the [HTML] release notes. Replacing the second "Mesa ... release notes$date" with something like above would be great, but optional. What a shame, I haven't seen this before. I will update to a new format. Before I make any change, I've manually changed just one file[1] Can you check it and see if its OK now? If not, please leave a comment and more suggestions :) [1]: http://mesa2.jeanhertel.com.br/relnotes/17.0.4.html Note: This message will be sent twice to the list, because my outlook account is crazy and is sending messages very slowly. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 26 April 2017 at 12:56, Jean Hertelwrote: >>On 2017-04-26 at 08:13, Emil Velikov wrote: > >>Thanks again for doing this Jean. A handful of, mostly trivial, questions. >> >> - Is there a website where one can check the output of specific >>Sphinx markdown. > > I have searched for such a thing too, but have not found :( > :-( >> - Any ideas why the page contents are so narrow? It seems theme >>related, doesn't it. > > Yes, it's theme related. > I have quickly readed the Kernel DRM docs, and it seems they have maded > a litle fix in the CSS for this. I will provide a fix soon too. > No worries - we can always change/polish the theme as needed. Just checking that there's nothing 'fundamentally broken' there. >> - Personally I would not bother, yet, with the non-html documents. >>These are quite picky to format correctly, as you've spotted already. > > Well, they are already formated now :) > I will fix the small issues pointed by Eric. > Right - I was skimming through 4.1 where the spacing in the number lists is still funky. Either way I'm not saying that we should throw your work there. Just that those will need closer look (read will take more time) than their HTML brethren. >> - The Gallium and NIR documentation might be better suited in the toctree. > > Ok, will fix that too. > >> - Maybe apply something like the following to the release notes >>s|Mesa X Release Notes / $date|Overview\n\nRelease date: $date| >> > > Do you mean in all the release notes? > Please remember that, the first title (the one with at bottom) > of the file is used by Sphinx when generating the links. > So I have added two titles in every release note, > one for the link generation, and another for the original title. > To visualise what I'm talking about observe the TOC as you open any of the [HTML] release notes. Replacing the second "Mesa ... release notes$date" with something like above would be great, but optional. Thanks Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 26 April 2017 at 12:18, Eric Engestromwrote: > On Wednesday, 2017-04-26 12:13:17 +0100, Emil Velikov wrote: >> Eric, >> Not sure that squashing 200+ changes (resulting in a total of +37K >> -41K change stat) in one big blob is a wise move. >> Since those are going to be pushed at once, there should be >> limited-to-no side effects to mesa3d.org. Or perhaps there's another >> reason why we'd want the lot squashed? > > Sorry if I wasn't clear, but my intention is to keep the history as it > currently is on Jean's branch, except for the 3 commits I mentioned and > any fixup commit that might be added later. > I did ask however if someone had any issues with this (keeping so many > commits), in which case we could squash it completely, which I'm > guessing is the source of the confusion. > Perhaps coffee was low as i've read it. Thanks for the confirmation. -Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
>On 2017-04-26 06:23, Eric Engestrom wrote: > > >Perfect, thanks! >I left a couple comments on 0658cf3db95c77dbe590. > Ok, I will focus on fixing the issues pointed out. >> >> Foot Note: Some changes are still necessary because some specification files >> (patents.txt, libGL.txt, features.txt, etc) >> need to be exported directly to the output folder. > >I see you added a commit since your email (922e597521833875c9e5), which >essentially exports all these files to the website. >I'd argue most (if not all) of these files only make sense in the repo, >not on the website, so I think that commit can be dropped. I understand that those files are not essential, but would be nice if we can leave them in the website, as Search Engines have already linked it. > >I suggest you fix any issue from now on with `--fixup` commits (I'm >taking back my rebasing suggestion), and I'll squash those when merging. >This way, comments left on github commits won't be lost by rebasing. > >I'll also squash your 3 "fix issue with sphinx-generator" with their >respective file commits. Ok, my next commits will use `--fixup`. Thanks for the suggestion :) ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
>On 2017-04-26 at 08:13, Emil Velikovwrote: >Thanks again for doing this Jean. A handful of, mostly trivial, questions. > > - Is there a website where one can check the output of specific >Sphinx markdown. I have searched for such a thing too, but have not found :( > - Any ideas why the page contents are so narrow? It seems theme >related, doesn't it. Yes, it's theme related. I have quickly readed the Kernel DRM docs, and it seems they have maded a litle fix in the CSS for this. I will provide a fix soon too. > - Personally I would not bother, yet, with the non-html documents. >These are quite picky to format correctly, as you've spotted already. Well, they are already formated now :) I will fix the small issues pointed by Eric. > - The Gallium and NIR documentation might be better suited in the toctree. Ok, will fix that too. > - Maybe apply something like the following to the release notes >s|Mesa X Release Notes / $date|Overview\n\nRelease date: $date| > Do you mean in all the release notes? Please remember that, the first title (the one with at bottom) of the file is used by Sphinx when generating the links. So I have added two titles in every release note, one for the link generation, and another for the original title. > >Thanks >Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On Wednesday, 2017-04-26 12:13:17 +0100, Emil Velikov wrote: > Eric, > Not sure that squashing 200+ changes (resulting in a total of +37K > -41K change stat) in one big blob is a wise move. > Since those are going to be pushed at once, there should be > limited-to-no side effects to mesa3d.org. Or perhaps there's another > reason why we'd want the lot squashed? Sorry if I wasn't clear, but my intention is to keep the history as it currently is on Jean's branch, except for the 3 commits I mentioned and any fixup commit that might be added later. I did ask however if someone had any issues with this (keeping so many commits), in which case we could squash it completely, which I'm guessing is the source of the confusion. > > Thanks > Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 25 April 2017 at 19:56, Jean Hertelwrote: >>On 2017-04-24 12:40, Eric Engestrom wrote: >> >>Sorry I haven't had time to look at this until now. >> >>I just had a look, and besides style that can be tweaked later, I think >>the main issue is that the homepage a visitor lands on when just typing >>'mesa3d.org' should be more than a simple duplicate of the ToC. >> >>The 'recent releases' list we currently have gives at least that >>information, and I would like to keep that until (if) we find something >>else/better. > > OK, I've updated the demo site with this. > Please visit: http://mesa2.jeanhertel.com.br > >>Another thing, can you please make a (rebasing) branch with a commit per >>file converted, where the old file is deleted and the new created? >>That way, it can be easily verified that the content was correctly >>converted (no information lost; typo fixes and the like are ok) and more >>importantly it makes it obvious at merge time that a file has been >>changed in its html form, and the corresponding change can be made on >>the rst file. > > Ok, I've done one commit per file change, see it here: > https://github.com/jlHertel/mesa/tree/sphinx-docs > > Foot Note: Some changes are still necessary because some specification files > (patents.txt, libGL.txt, features.txt, etc) > need to be exported directly to the output folder. Thanks again for doing this Jean. A handful of, mostly trivial, questions. - Is there a website where one can check the output of specific Sphinx markdown. - Any ideas why the page contents are so narrow? It seems theme related, doesn't it. - Personally I would not bother, yet, with the non-html documents. These are quite picky to format correctly, as you've spotted already. - The Gallium and NIR documentation might be better suited in the toctree. - Maybe apply something like the following to the release notes s|Mesa X Release Notes / $date|Overview\n\nRelease date: $date| Eric, Not sure that squashing 200+ changes (resulting in a total of +37K -41K change stat) in one big blob is a wise move. Since those are going to be pushed at once, there should be limited-to-no side effects to mesa3d.org. Or perhaps there's another reason why we'd want the lot squashed? Thanks Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On Tuesday, 2017-04-25 18:56:53 +, Jean Hertel wrote: > >On 2017-04-24 12:40, Eric Engestrom wrote: > > > >Sorry I haven't had time to look at this until now. > > > >I just had a look, and besides style that can be tweaked later, I think > >the main issue is that the homepage a visitor lands on when just typing > >'mesa3d.org' should be more than a simple duplicate of the ToC. > > > >The 'recent releases' list we currently have gives at least that > >information, and I would like to keep that until (if) we find something > >else/better. > > OK, I've updated the demo site with this. > Please visit: http://mesa2.jeanhertel.com.br Perfect, thanks! I left a couple comments on 0658cf3db95c77dbe590. > > >Another thing, can you please make a (rebasing) branch with a commit per > >file converted, where the old file is deleted and the new created? > >That way, it can be easily verified that the content was correctly > >converted (no information lost; typo fixes and the like are ok) and more > >importantly it makes it obvious at merge time that a file has been > >changed in its html form, and the corresponding change can be made on > >the rst file. > > Ok, I've done one commit per file change, see it here: > https://github.com/jlHertel/mesa/tree/sphinx-docs Yup, that's exactly what I had in mind :) I left a comment on d88398cf8fc0588e7afd, but what I've seen of the rest looks good to me. Now we "just" need to review every single file to make sure everything's OK. I suggest everyone who reviews a few file leaves a reply to this mail with the list of file they reviewed and their r-b, or directly on the github commits for each file. I'll add those r-b's to each commit when merging. The list of commits can be easily seen on this page: https://github.com/jlHertel/mesa/compare/sphinx-docs > > Foot Note: Some changes are still necessary because some specification files > (patents.txt, libGL.txt, features.txt, etc) > need to be exported directly to the output folder. I see you added a commit since your email (922e597521833875c9e5), which essentially exports all these files to the website. I'd argue most (if not all) of these files only make sense in the repo, not on the website, so I think that commit can be dropped. I suggest you fix any issue from now on with `--fixup` commits (I'm taking back my rebasing suggestion), and I'll squash those when merging. This way, comments left on github commits won't be lost by rebasing. I'll also squash your 3 "fix issue with sphinx-generator" with their respective file commits. Anyone looking for a next step, a few ideas: - integrate the gallium & nir docs - add overview documentation for each module - add sphinx comments in the code, pull these into module pages (functions, structs, enums, etc.). - reach the DRM kerneldocs-level of documentation [1] - ??? - profit! Cheers, Eric [1] https://dri.freedesktop.org/docs/drm/gpu/index.html ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
>On 2017-04-24 12:40, Eric Engestrom wrote: > >Sorry I haven't had time to look at this until now. > >I just had a look, and besides style that can be tweaked later, I think >the main issue is that the homepage a visitor lands on when just typing >'mesa3d.org' should be more than a simple duplicate of the ToC. > >The 'recent releases' list we currently have gives at least that >information, and I would like to keep that until (if) we find something >else/better. OK, I've updated the demo site with this. Please visit: http://mesa2.jeanhertel.com.br >Another thing, can you please make a (rebasing) branch with a commit per >file converted, where the old file is deleted and the new created? >That way, it can be easily verified that the content was correctly >converted (no information lost; typo fixes and the like are ok) and more >importantly it makes it obvious at merge time that a file has been >changed in its html form, and the corresponding change can be made on >the rst file. Ok, I've done one commit per file change, see it here: https://github.com/jlHertel/mesa/tree/sphinx-docs Foot Note: Some changes are still necessary because some specification files (patents.txt, libGL.txt, features.txt, etc) need to be exported directly to the output folder. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hello Brian, thanks for the response. About the docs title, it's already "The Mesa 3D Graphics Library". If you have any doubts, please see an example of the generated website here: http://mesa2.jeanhertel.com.br/ About the font-size, that's defined directly by the theme. It is possible to create your own CSS file to replace this, or write our own theme, but I think it's not worth the effort, especially since all websites that use this theme have this same font size. Best Regards, Jean Hertel De: Brian Paul <bri...@vmware.com> Enviado: quinta-feira, 20 de abril de 2017 16:10 Para: Emil Velikov; Jean Hertel; Eric Engestrom Cc: Vedran Miletić; Jason Ekstrand; mesa-dev@lists.freedesktop.org Assunto: Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx On 04/19/2017 05:23 AM, Emil Velikov wrote: > On 11 April 2017 at 13:10, Jean Hertel <jean.her...@hotmail.com> wrote: >> Any more thoughts on this? >> >> >> I would really appreciate feedback from more contributors. >> > Indeed. > > Brian, Eric, others - how do you feel with the Sphinx edition of the site? > If the current theme feels a bit off there's others available [1]. > Then again, that can be changed/polished at any later stage. I guess it looks OK to me. I was looking more closely at Sphinx markup and it seems pretty simple. I think we'll want the mesa3d.org website to auto-update when someone checks in changes to the Sphinx files. Hopefully, the fd.o admins can rig that up without too much trouble. One note: I've always referred to the project as just "Mesa" or "The Mesa 3-D Graphics Library". I only used mesa3d.org for the website because mesa.org was taken. So I'd suggest replacing the string "Mesa 3D" with one of the others. Also, could we use a slightly smaller font? The text seems a bit larger than necessary. -Brian ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Sorry I haven't had time to look at this until now. I just had a look, and besides style that can be tweaked later, I think the main issue is that the homepage a visitor lands on when just typing 'mesa3d.org' should be more than a simple duplicate of the ToC. The 'recent releases' list we currently have gives at least that information, and I would like to keep that until (if) we find something else/better. Another thing, can you please make a (rebasing) branch with a commit per file converted, where the old file is deleted and the new created? That way, it can be easily verified that the content was correctly converted (no information lost; typo fixes and the like are ok) and more importantly it makes it obvious at merge time that a file has been changed in its html form, and the corresponding change can be made on the rst file. I think we'd squash this into a single commit when merging though, to avoid commit noise (unless we don't care?), but until then I think this is the best form. On Thursday, 2017-04-20 13:10:42 -0600, Brian Paul wrote: > On 04/19/2017 05:23 AM, Emil Velikov wrote: > > On 11 April 2017 at 13:10, Jean Hertelwrote: > > > Any more thoughts on this? > > > > > > > > > I would really appreciate feedback from more contributors. > > > > > Indeed. > > > > Brian, Eric, others - how do you feel with the Sphinx edition of the site? > > If the current theme feels a bit off there's others available [1]. > > Then again, that can be changed/polished at any later stage. > > I guess it looks OK to me. I was looking more closely at Sphinx markup and > it seems pretty simple. > > I think we'll want the mesa3d.org website to auto-update when someone checks > in changes to the Sphinx files. Hopefully, the fd.o admins can rig that up > without too much trouble. I can rig it up, but I need to learn about python venv so it'll take some time. DanielS is helping me with this. With the branch I suggested, delays shouldn't be an issue, as changes would be easy to track. Cheers, Eric > > One note: I've always referred to the project as just "Mesa" or "The Mesa > 3-D Graphics Library". I only used mesa3d.org for the website because > mesa.org was taken. So I'd suggest replacing the string "Mesa 3D" with one > of the others. > > Also, could we use a slightly smaller font? The text seems a bit larger > than necessary. > > -Brian > ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 04/19/2017 05:23 AM, Emil Velikov wrote: On 11 April 2017 at 13:10, Jean Hertelwrote: Any more thoughts on this? I would really appreciate feedback from more contributors. Indeed. Brian, Eric, others - how do you feel with the Sphinx edition of the site? If the current theme feels a bit off there's others available [1]. Then again, that can be changed/polished at any later stage. I guess it looks OK to me. I was looking more closely at Sphinx markup and it seems pretty simple. I think we'll want the mesa3d.org website to auto-update when someone checks in changes to the Sphinx files. Hopefully, the fd.o admins can rig that up without too much trouble. One note: I've always referred to the project as just "Mesa" or "The Mesa 3-D Graphics Library". I only used mesa3d.org for the website because mesa.org was taken. So I'd suggest replacing the string "Mesa 3D" with one of the others. Also, could we use a slightly smaller font? The text seems a bit larger than necessary. -Brian ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 11 April 2017 at 13:10, Jean Hertelwrote: > Any more thoughts on this? > > > I would really appreciate feedback from more contributors. > Indeed. Brian, Eric, others - how do you feel with the Sphinx edition of the site? If the current theme feels a bit off there's others available [1]. Then again, that can be changed/polished at any later stage. Thanks Emil [1] http://www.sphinx-doc.org/en/stable/theming.html http://www.writethedocs.org/guide/tools/sphinx-themes/ ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Any more thoughts on this? I would really appreciate feedback from more contributors. Best Regards. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 04/05/2017 04:17 PM, Emil Velikov wrote: > On 5 April 2017 at 12:36, Jean Hertelwrote: >> This proposal tries to fix those issues. >> >> >> Oficial repository: https://github.com/jlHertel/mesa-sphinx >> >> Live demo: http://mesa2.jeanhertel.com.br/ >> > Thanks for the update Jean. > > I'm a huge fan of this since we can have all the documentation with > consistent look and in one place. > Plus if we get tired of the RTD look we can easily change the theme or > write our own ;-) > > Personally I think the only thing that's missing is the News > (index.html) page and with that we can all the lot. > As you mentioned there's a few places where things can be > improved/rewritten but that can follow in due time. > Second all points. It's very nice and big improvement over the current website, not to mention easier to maintain. As for the theme, I suggest Guzzle [1] instead; RTD is very pretty, but it's also fairly common, as is Bootswatch. Guzzle is pretty and not so commonly used, as far as my anecdotal experience goes. Regards, Vedran [1] https://github.com/guzzle/guzzle_sphinx_theme -- Vedran Miletić vedran.miletic.net ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
On 5 April 2017 at 12:36, Jean Hertelwrote: > Hello, > > > This is the second proposal for a rewrite of mesa website. > > > The last proposal have some problems (still available here: > http://mesa.jeanhertel.com.br/): > > Use of big libraries like Twitter Bootstrap for the CSS; > The design was focusing more on a blog-style instead of a documentation > style; > The rewrite was using Markdown, while there is already lots of documentation > using reStructured Text; > > > This proposal tries to fix those issues. > > > Oficial repository: https://github.com/jlHertel/mesa-sphinx > > Live demo: http://mesa2.jeanhertel.com.br/ > > > As already pointed out, there was a conversion done some months ago by > Nicholas Bishop. If you look carefully, you will note that my conversion is > basically the same. > > > The point here is about other pieces of documentations that needs to be > writen, or extracted from the source code. > > > I have readed some projects documentation (mainly in PHP) and the common > case is to use tools like doxygen to generate an "API view" of classes, > functions, etc. > > And use the main website to write specific articles covering things not too > obviously or to show some samples of usage. > > > To bring this approach to mesa, lets imagine an example with the GL Dispatch > function. > > In the main website (mesa3d.org) there is an article explaining exactly how > the dispatcher works, why it was designed this way, and what advantages it > can take on some operating systems and configurations. > > In the API documentation site (that I imagine will be a sub-site under > mesa3d.org) there will be the function/macro declarations for it. > Thanks for the update Jean. I'm a huge fan of this since we can have all the documentation with consistent look and in one place. Plus if we get tired of the RTD look we can easily change the theme or write our own ;-) Personally I think the only thing that's missing is the News (index.html) page and with that we can all the lot. As you mentioned there's a few places where things can be improved/rewritten but that can follow in due time. Thanks again Emil ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
[Mesa-dev] [RFC] - Rewrite mesa website in Sphinx
Hello, This is the second proposal for a rewrite of mesa website. The last proposal have some problems (still available here: http://mesa.jeanhertel.com.br/): * Use of big libraries like Twitter Bootstrap for the CSS; * The design was focusing more on a blog-style instead of a documentation style; * The rewrite was using Markdown, while there is already lots of documentation using reStructured Text; This proposal tries to fix those issues. Oficial repository: https://github.com/jlHertel/mesa-sphinx Live demo: http://mesa2.jeanhertel.com.br/ As already pointed out, there was a conversion done some months ago by Nicholas Bishop. If you look carefully, you will note that my conversion is basically the same. The point here is about other pieces of documentations that needs to be writen, or extracted from the source code. I have readed some projects documentation (mainly in PHP) and the common case is to use tools like doxygen to generate an "API view" of classes, functions, etc. And use the main website to write specific articles covering things not too obviously or to show some samples of usage. To bring this approach to mesa, lets imagine an example with the GL Dispatch function. In the main website (mesa3d.org) there is an article explaining exactly how the dispatcher works, why it was designed this way, and what advantages it can take on some operating systems and configurations. In the API documentation site (that I imagine will be a sub-site under mesa3d.org) there will be the function/macro declarations for it. Please, feel free to comment on this and suggest any other ideas. Thanks in advance. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev