Re: [Piglit] Piglit website in sphinx
Quoting Jordan Justen (2019-01-07 11:50:43) > On 2018-12-18 14:57:43, Dylan Baker wrote: > > Quoting Eric Anholt (2018-12-18 11:21:08) > > > Jordan Justen writes: > > > > > > > On 2018-12-17 22:07:21, Tapani Pälli wrote: > > > >> Hi; > > > >> > > > >> On 12/17/18 11:50 AM, Jordan Justen wrote: > > > >> > Although I doubt it generates much traffic, I wanted to try to > > > >> > convert > > > >> > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > > > >> > gitlab branch. > > > >> > > > > >> > I think the current site was built by ikiwiki, but I was after > > > >> > spending way more time that I hoped, I still was unable to reproduce > > > >> > the site without lots of extra undesirable links. > > > >> > > > > >> > So, I tried converting it to sphinx. Of course, I expected it would > > > >> > look somewhat different with sphinx. This change proved much easier, > > > >> > and I think looks pretty good: > > > >> > > > > >> > https://jljusten.pages.freedesktop.org/piglit/ > > > >> > > > >> Looks nice and clean! Maybe at same time the documentation could be > > > >> improved. Some of the Piglit options seem to be missing, as example I > > > >> never saw PIGLIT_PLATFORM documented, there is no list of platforms so > > > >> only way is to grep the source ... or are they somewhere? > > > > > > > > Eric pointed out that it could be good to make the website sources > > > > appear under the docs directory, like Mesa does. I made the changes to > > > > do that here: > > > > > > > > https://gitlab.freedesktop.org/jljusten/piglit/commits/master > > > > > > > > With this version, the website would be rebuilt whenever the docs > > > > directory changes on the master branch. > > > > > > > > I guess my point is that by putting the website under the docs > > > > directory of the main branch, maybe it will allow others to contribute > > > > changes (like this) more easily. :) > > > > > > > > Another change that we might consider is whether to use merge requests > > > > in piglit. That would also require a change to the website. > > > > > > This looks pretty nice to me. > > > > > > Acked-by: Eric Anholt > > > > I also think it looks pretty nice, and doesn't require me bothering Daniel > > Stone > > to remind me how to update the webpage when it needs to happen every 10 > > years or > > so... > > > > Acked-by: Dylan Baker > > Eric, Dylan, > > I didn't really follow the normal process of posting patches, yet I > think 2 Acked-by is better than average for code review on piglit. :) > > Should I post the patches to the list, or just merge it with your > guys' acks? > > -Jordan Just push it with acks. Dylan signature.asc Description: signature ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
On 2018-12-18 14:57:43, Dylan Baker wrote: > Quoting Eric Anholt (2018-12-18 11:21:08) > > Jordan Justen writes: > > > > > On 2018-12-17 22:07:21, Tapani Pälli wrote: > > >> Hi; > > >> > > >> On 12/17/18 11:50 AM, Jordan Justen wrote: > > >> > Although I doubt it generates much traffic, I wanted to try to convert > > >> > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > > >> > gitlab branch. > > >> > > > >> > I think the current site was built by ikiwiki, but I was after > > >> > spending way more time that I hoped, I still was unable to reproduce > > >> > the site without lots of extra undesirable links. > > >> > > > >> > So, I tried converting it to sphinx. Of course, I expected it would > > >> > look somewhat different with sphinx. This change proved much easier, > > >> > and I think looks pretty good: > > >> > > > >> > https://jljusten.pages.freedesktop.org/piglit/ > > >> > > >> Looks nice and clean! Maybe at same time the documentation could be > > >> improved. Some of the Piglit options seem to be missing, as example I > > >> never saw PIGLIT_PLATFORM documented, there is no list of platforms so > > >> only way is to grep the source ... or are they somewhere? > > > > > > Eric pointed out that it could be good to make the website sources > > > appear under the docs directory, like Mesa does. I made the changes to > > > do that here: > > > > > > https://gitlab.freedesktop.org/jljusten/piglit/commits/master > > > > > > With this version, the website would be rebuilt whenever the docs > > > directory changes on the master branch. > > > > > > I guess my point is that by putting the website under the docs > > > directory of the main branch, maybe it will allow others to contribute > > > changes (like this) more easily. :) > > > > > > Another change that we might consider is whether to use merge requests > > > in piglit. That would also require a change to the website. > > > > This looks pretty nice to me. > > > > Acked-by: Eric Anholt > > I also think it looks pretty nice, and doesn't require me bothering Daniel > Stone > to remind me how to update the webpage when it needs to happen every 10 years > or > so... > > Acked-by: Dylan Baker Eric, Dylan, I didn't really follow the normal process of posting patches, yet I think 2 Acked-by is better than average for code review on piglit. :) Should I post the patches to the list, or just merge it with your guys' acks? -Jordan ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
Quoting Eric Anholt (2018-12-18 11:21:08) > Jordan Justen writes: > > > On 2018-12-17 22:07:21, Tapani Pälli wrote: > >> Hi; > >> > >> On 12/17/18 11:50 AM, Jordan Justen wrote: > >> > Although I doubt it generates much traffic, I wanted to try to convert > >> > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > >> > gitlab branch. > >> > > >> > I think the current site was built by ikiwiki, but I was after > >> > spending way more time that I hoped, I still was unable to reproduce > >> > the site without lots of extra undesirable links. > >> > > >> > So, I tried converting it to sphinx. Of course, I expected it would > >> > look somewhat different with sphinx. This change proved much easier, > >> > and I think looks pretty good: > >> > > >> > https://jljusten.pages.freedesktop.org/piglit/ > >> > >> Looks nice and clean! Maybe at same time the documentation could be > >> improved. Some of the Piglit options seem to be missing, as example I > >> never saw PIGLIT_PLATFORM documented, there is no list of platforms so > >> only way is to grep the source ... or are they somewhere? > > > > Eric pointed out that it could be good to make the website sources > > appear under the docs directory, like Mesa does. I made the changes to > > do that here: > > > > https://gitlab.freedesktop.org/jljusten/piglit/commits/master > > > > With this version, the website would be rebuilt whenever the docs > > directory changes on the master branch. > > > > I guess my point is that by putting the website under the docs > > directory of the main branch, maybe it will allow others to contribute > > changes (like this) more easily. :) > > > > Another change that we might consider is whether to use merge requests > > in piglit. That would also require a change to the website. > > This looks pretty nice to me. > > Acked-by: Eric Anholt I also think it looks pretty nice, and doesn't require me bothering Daniel Stone to remind me how to update the webpage when it needs to happen every 10 years or so... Acked-by: Dylan Baker signature.asc Description: signature ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
Jordan Justen writes: > On 2018-12-17 22:07:21, Tapani Pälli wrote: >> Hi; >> >> On 12/17/18 11:50 AM, Jordan Justen wrote: >> > Although I doubt it generates much traffic, I wanted to try to convert >> > the https://piglit.freedesktop.org/ homepage into an 'auto-building' >> > gitlab branch. >> > >> > I think the current site was built by ikiwiki, but I was after >> > spending way more time that I hoped, I still was unable to reproduce >> > the site without lots of extra undesirable links. >> > >> > So, I tried converting it to sphinx. Of course, I expected it would >> > look somewhat different with sphinx. This change proved much easier, >> > and I think looks pretty good: >> > >> > https://jljusten.pages.freedesktop.org/piglit/ >> >> Looks nice and clean! Maybe at same time the documentation could be >> improved. Some of the Piglit options seem to be missing, as example I >> never saw PIGLIT_PLATFORM documented, there is no list of platforms so >> only way is to grep the source ... or are they somewhere? > > Eric pointed out that it could be good to make the website sources > appear under the docs directory, like Mesa does. I made the changes to > do that here: > > https://gitlab.freedesktop.org/jljusten/piglit/commits/master > > With this version, the website would be rebuilt whenever the docs > directory changes on the master branch. > > I guess my point is that by putting the website under the docs > directory of the main branch, maybe it will allow others to contribute > changes (like this) more easily. :) > > Another change that we might consider is whether to use merge requests > in piglit. That would also require a change to the website. This looks pretty nice to me. Acked-by: Eric Anholt signature.asc Description: PGP signature ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
On 12/18/18 9:58 AM, Jordan Justen wrote: On 2018-12-17 22:07:21, Tapani Pälli wrote: Hi; On 12/17/18 11:50 AM, Jordan Justen wrote: Although I doubt it generates much traffic, I wanted to try to convert the https://piglit.freedesktop.org/ homepage into an 'auto-building' gitlab branch. I think the current site was built by ikiwiki, but I was after spending way more time that I hoped, I still was unable to reproduce the site without lots of extra undesirable links. So, I tried converting it to sphinx. Of course, I expected it would look somewhat different with sphinx. This change proved much easier, and I think looks pretty good: https://jljusten.pages.freedesktop.org/piglit/ Looks nice and clean! Maybe at same time the documentation could be improved. Some of the Piglit options seem to be missing, as example I never saw PIGLIT_PLATFORM documented, there is no list of platforms so only way is to grep the source ... or are they somewhere? Eric pointed out that it could be good to make the website sources appear under the docs directory, like Mesa does. I made the changes to do that here: https://gitlab.freedesktop.org/jljusten/piglit/commits/master With this version, the website would be rebuilt whenever the docs directory changes on the master branch. I guess my point is that by putting the website under the docs directory of the main branch, maybe it will allow others to contribute changes (like this) more easily. :) Yes, that makes sense. Maybe I can contribute instructions for PIGLIT_PLATFORM when this comes available :) Another change that we might consider is whether to use merge requests in piglit. That would also require a change to the website. -Jordan The source code is here in this branch: https://gitlab.freedesktop.org/jljusten/piglit/commits/website It is setup such that we could add a small 'website' branch to the piglit repo. The branch's history would be detacted from the source code history. Then, if we need to change the piglit website again, in, say a decade or so :), it'll be a bit simpler. Does it look ok, and does it seem like an ok plan? -Jordan ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
On 2018-12-17 22:07:21, Tapani Pälli wrote: > Hi; > > On 12/17/18 11:50 AM, Jordan Justen wrote: > > Although I doubt it generates much traffic, I wanted to try to convert > > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > > gitlab branch. > > > > I think the current site was built by ikiwiki, but I was after > > spending way more time that I hoped, I still was unable to reproduce > > the site without lots of extra undesirable links. > > > > So, I tried converting it to sphinx. Of course, I expected it would > > look somewhat different with sphinx. This change proved much easier, > > and I think looks pretty good: > > > > https://jljusten.pages.freedesktop.org/piglit/ > > Looks nice and clean! Maybe at same time the documentation could be > improved. Some of the Piglit options seem to be missing, as example I > never saw PIGLIT_PLATFORM documented, there is no list of platforms so > only way is to grep the source ... or are they somewhere? Eric pointed out that it could be good to make the website sources appear under the docs directory, like Mesa does. I made the changes to do that here: https://gitlab.freedesktop.org/jljusten/piglit/commits/master With this version, the website would be rebuilt whenever the docs directory changes on the master branch. I guess my point is that by putting the website under the docs directory of the main branch, maybe it will allow others to contribute changes (like this) more easily. :) Another change that we might consider is whether to use merge requests in piglit. That would also require a change to the website. -Jordan > > The source code is here in this branch: > > > > https://gitlab.freedesktop.org/jljusten/piglit/commits/website > > > > It is setup such that we could add a small 'website' branch to the > > piglit repo. The branch's history would be detacted from the source > > code history. > > > > Then, if we need to change the piglit website again, in, say a decade > > or so :), it'll be a bit simpler. > > > > Does it look ok, and does it seem like an ok plan? > > > > -Jordan > > ___ > > Piglit mailing list > > Piglit@lists.freedesktop.org > > https://lists.freedesktop.org/mailman/listinfo/piglit > > ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
Hi; On 12/17/18 11:50 AM, Jordan Justen wrote: Although I doubt it generates much traffic, I wanted to try to convert the https://piglit.freedesktop.org/ homepage into an 'auto-building' gitlab branch. I think the current site was built by ikiwiki, but I was after spending way more time that I hoped, I still was unable to reproduce the site without lots of extra undesirable links. So, I tried converting it to sphinx. Of course, I expected it would look somewhat different with sphinx. This change proved much easier, and I think looks pretty good: https://jljusten.pages.freedesktop.org/piglit/ Looks nice and clean! Maybe at same time the documentation could be improved. Some of the Piglit options seem to be missing, as example I never saw PIGLIT_PLATFORM documented, there is no list of platforms so only way is to grep the source ... or are they somewhere? The source code is here in this branch: https://gitlab.freedesktop.org/jljusten/piglit/commits/website It is setup such that we could add a small 'website' branch to the piglit repo. The branch's history would be detacted from the source code history. Then, if we need to change the piglit website again, in, say a decade or so :), it'll be a bit simpler. Does it look ok, and does it seem like an ok plan? -Jordan ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
On 2018-12-17 12:09:23, Eric Anholt wrote: > Jordan Justen writes: > > > Although I doubt it generates much traffic, I wanted to try to convert > > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > > gitlab branch. > > > > I think the current site was built by ikiwiki, but I was after > > spending way more time that I hoped, I still was unable to reproduce > > the site without lots of extra undesirable links. > > > > So, I tried converting it to sphinx. Of course, I expected it would > > look somewhat different with sphinx. This change proved much easier, > > and I think looks pretty good: > > > > https://jljusten.pages.freedesktop.org/piglit/ > > > > The source code is here in this branch: > > > > https://gitlab.freedesktop.org/jljusten/piglit/commits/website > > > > It is setup such that we could add a small 'website' branch to the > > piglit repo. The branch's history would be detacted from the source > > code history. > > > > Then, if we need to change the piglit website again, in, say a decade > > or so :), it'll be a bit simpler. > > > > Does it look ok, and does it seem like an ok plan? > > Looks nice to me, only nit is the title is "Piglit 1 documentation" -- > where did that "1" come from? Whoops. :) I guess the full title was "Piglit -- Piglit 1 documentation". If I set "html_title = None" in the config file, it becomes "Piglit". > I kind of like having the website in master so that some of the contents > on the site can be documentation in-tree as well, but I'm happy with it > at least being easily modifiable. I can look into embedding it in master for piglit. For waffle, we're looking at something kind of similar for the website, but we also have the release tarballs in the website. Therefore, we want to use a separate branch so the tarballs can use git-lfs, and not be part of the main repo. With git-lfs the tarballs are downloaded when you checkout the website branch, but not if you just clone the repo. -Jordan ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
Re: [Piglit] Piglit website in sphinx
Jordan Justen writes: > Although I doubt it generates much traffic, I wanted to try to convert > the https://piglit.freedesktop.org/ homepage into an 'auto-building' > gitlab branch. > > I think the current site was built by ikiwiki, but I was after > spending way more time that I hoped, I still was unable to reproduce > the site without lots of extra undesirable links. > > So, I tried converting it to sphinx. Of course, I expected it would > look somewhat different with sphinx. This change proved much easier, > and I think looks pretty good: > > https://jljusten.pages.freedesktop.org/piglit/ > > The source code is here in this branch: > > https://gitlab.freedesktop.org/jljusten/piglit/commits/website > > It is setup such that we could add a small 'website' branch to the > piglit repo. The branch's history would be detacted from the source > code history. > > Then, if we need to change the piglit website again, in, say a decade > or so :), it'll be a bit simpler. > > Does it look ok, and does it seem like an ok plan? Looks nice to me, only nit is the title is "Piglit 1 documentation" -- where did that "1" come from? I kind of like having the website in master so that some of the contents on the site can be documentation in-tree as well, but I'm happy with it at least being easily modifiable. signature.asc Description: PGP signature ___ Piglit mailing list Piglit@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/piglit
