Re: [DISCUSS] Website Overhaul
I did some research tonight and here are my findings. - Are there examples of other sites using Hugo? There are sites using static site generators (SSG) and below is a quick survey of what's being used. + The following sites use docusaurus (MIT) * Yunikorn: https://github.com/apache/incubator-yunikorn-site * InLong: https://github.com/apache/incubator-inlong-website * Shenyu: https://github.com/apache/incubator-shenyu-website * Linkis: https://github.com/apache/incubator-linkis-website * Seatunnel: https://github.com/apache/incubator-seatunnel-website * Eventmesh: https://github.com/apache/incubator-eventmesh-site * StreamPipes: https://github.com/apache/incubator-streampipes-website + The following sites use Jekyll (MIT) * Nuttx: https://github.com/apache/incubator-nuttx-website * brpc: https://github.com/apache/incubator-brpc-website * Tuweni: https://github.com/apache/incubator-tuweni-website * Wayang: https://github.com/apache/incubator-wayang-website * Pegasus: https://github.com/apache/incubator-pegasus-website * Livy: https://github.com/apache/incubator-livy-website + The following sites use Vuepress (MIT) * Doris: https://github.com/apache/incubator-doris-website * Teaclave: https://github.com/apache/incubator-teaclave-website + The following sites use Hugo (Apache) * Kyuubi: https://github.com/apache/incubator-kyuubi-website (doesn't do docs) + The following sites use Eleventy (MIT) * Annotator: https://github.com/apache/incubator-annotator-website - Can we maintain multiple versions of the docs using Hugo? + I think so. If using Docsy, they address that here: https://www.docsy.dev/docs/adding-content/versioning/ * An example of a site doing this is here (top right corner is version switcher): https://www.kubeflow.org/docs/ + I also found Doks, which is an npm wrapper around Hugo. This page describes versioning: https://getdoks.org/docs/extensions/versioned-documentation/ From: Jasper Blues Sent: Thursday, February 10, 2022 4:36 PM To: dev@age.apache.org Subject: Re: [DISCUSS] Website Overhaul Sounds great. Also visible links in and out of the site should help with Google site ranking as well as sharing. For example, by giving bloggers, social media users etc links that relate directly to their talking points. > On Feb 10, 2022, at 10:02 PM, Nicholas Sorrell wrote: > > All, > > I wanted to propose that we overhaul the website > (https://github.com/apache/incubator-age-website) to make it easier to > contribute to, easier to modify, more extensible, more accessible, and easier > to optimize for searching and performance. > > When I created the site, there were a couple of a factors in the design > decisions: > > Time - we were racing to get something done and presentable before a > conference the team was presenting at. This meant creating a site with > minimal "flare." > Libraries - when we built the site way back then, we weren't sure what 3rd > party libraries we could incorporate. We weren't sure if Apache had rules > limiting the use of them, so we chose to use no libraries. This also impacted > the site (negatively in my opinion). > > Since then, we've seen other Apache sites using 3rd party libs and we now > have time to redesign the site. I propose that we redesign the site using > Hugo. This gives us the ability to utilize Markdown, which is much more > accessible for contributors, and also offers more extensibility through > themes and plugins. I think it could also make the process of generating the > docs easier but I haven't fully investigated that. > > Another negative about the current website is linking to content. Because of > the way that I've utilized anchors to show/hide content, this keeps the URL > slug the same no matter where you go, which makes it difficult to share, for > example, a "Getting Started" page with someone. > > So in summary, here are the potential benefits I see: > + easier to modify: because the content is written in markdown, it is easier > for people change existing pages without knowledge of HTML/CSS/JS > + easier to contribute: again, because we will use markdown for content, it > is easier for people to contribute new content > + more extensible: because Hugo has a large ecosystem, we can tap into the > work of others > + more accessible: this redesign will also have a focus on accessibility so > all users can engage with the content > + better SEO: designing with SEO in mind so that users can find out about > AGE is important > + possibly easier to build docs: right now we're using a Github workflow to > generate these, and we could possibly wrap all of this into a single step of > static site generation with Hugo > + possible blog: another important aspect of both SEO and community > engagement is a blog, which can show examples and use cases of AGE's new > functionality
[GitHub] [incubator-age] bravius commented on issue #161: Index is lost after using SET clause
bravius commented on issue #161: URL: https://github.com/apache/incubator-age/issues/161#issuecomment-1035612877 @pdpotter Okay I just checked that. When CREATE-ing a vertex with a duplicate key, I get "duplicate key value violates unique constraint", as expected. When I use MATCH and SET to update an existing vertex with a duplicate key, no error is thrown and the index seems to be completely ignored. It seems that SET syntax is bypassing index constraint checking, but CREATE syntax does get checked. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@age.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [DISCUSS] Website Overhaul
Sounds great. Also visible links in and out of the site should help with Google site ranking as well as sharing. For example, by giving bloggers, social media users etc links that relate directly to their talking points. > On Feb 10, 2022, at 10:02 PM, Nicholas Sorrell wrote: > > All, > > I wanted to propose that we overhaul the website > (https://github.com/apache/incubator-age-website) to make it easier to > contribute to, easier to modify, more extensible, more accessible, and easier > to optimize for searching and performance. > > When I created the site, there were a couple of a factors in the design > decisions: > > Time - we were racing to get something done and presentable before a > conference the team was presenting at. This meant creating a site with > minimal "flare." > Libraries - when we built the site way back then, we weren't sure what 3rd > party libraries we could incorporate. We weren't sure if Apache had rules > limiting the use of them, so we chose to use no libraries. This also impacted > the site (negatively in my opinion). > > Since then, we've seen other Apache sites using 3rd party libs and we now > have time to redesign the site. I propose that we redesign the site using > Hugo. This gives us the ability to utilize Markdown, which is much more > accessible for contributors, and also offers more extensibility through > themes and plugins. I think it could also make the process of generating the > docs easier but I haven't fully investigated that. > > Another negative about the current website is linking to content. Because of > the way that I've utilized anchors to show/hide content, this keeps the URL > slug the same no matter where you go, which makes it difficult to share, for > example, a "Getting Started" page with someone. > > So in summary, here are the potential benefits I see: > + easier to modify: because the content is written in markdown, it is easier > for people change existing pages without knowledge of HTML/CSS/JS > + easier to contribute: again, because we will use markdown for content, it > is easier for people to contribute new content > + more extensible: because Hugo has a large ecosystem, we can tap into the > work of others > + more accessible: this redesign will also have a focus on accessibility so > all users can engage with the content > + better SEO: designing with SEO in mind so that users can find out about > AGE is important > + possibly easier to build docs: right now we're using a Github workflow to > generate these, and we could possibly wrap all of this into a single step of > static site generation with Hugo > + possible blog: another important aspect of both SEO and community > engagement is a blog, which can show examples and use cases of AGE's new > functionality with each release. The approval process for blog posts should > probably part of a separate conversation. > > Looking forward to hearing the community's thoughts. > > Thanks, > Nick Sorrell >
[GitHub] [incubator-age] pdpotter commented on issue #161: Index is lost after using SET clause
pdpotter commented on issue #161: URL: https://github.com/apache/incubator-age/issues/161#issuecomment-1035350883 I tested out the function @bravius provided (thank you for sharing your solution!), but I am unfortunately still experiencing the same problems: * Before using any `SET` clauses, the unique index works as expected. * After executing a `SET` clause, I am able to create vertices with the id from the vertex that was updated in the `SET` clause. @bravius: did you get a duplicate key value violates unique constraint ERROR after updating a vertex with a `SET` clause? Did you use the example from the opening comment, or did you use another example to test your function? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@age.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [DISCUSS] Website Overhaul
As Pieterjan said, Sphinx allows us to have documentation for each release, which is a useful feature to have and we should try and keep it. However, if we are creating a new website then one of the side goals for accessibility should be a consistent theme throughout the website. Does Hugo and Sphinx have overlapping theme templates that could allow us to have both? On Thu, Feb 10, 2022 at 6:50 AM Pieterjan De Potter wrote: > I think this is a great idea. > > The current website consists of a single HTML page, which indeed makes > it more difficult to maintain, contribute to and link to content. > > I'm also in favor of using a static site generator to generate HTML out > of Markdown. Hugo seems to be one of the most (if not the most) popular > ones around, but I personally haven't used it yet. > > Are there examples of other Apache sites using Hugo? > > The documentation has already been converted to Markdown by Joe Fagan > and Josh Innis. Currently, Sphinx > (https://www.sphinx-doc.org/en/master/) is used to generate HTML pages. > In the current setup, multiple versions of the documentation can be > generated, which is not yet possible with Hugo as far as I could find > (https://github.com/google/docsy/issues/114). > > Best regards, > Pieterjan > > > On 10.02.22 15:02, Nicholas Sorrell wrote: > > All, > > > > I wanted to propose that we overhaul the website ( > https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fincubator-age-websitedata=04%7C01%7CPieterjan.DePotter%40ugent.be%7Cffb7ffea9a1945fe276108d9ec9df500%7Cd7811cdeecef496c8f91a1786241b99c%7C1%7C0%7C637800986184870331%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000sdata=e9J1J1i%2BIcLVZ2W2KsWvwSQTOEHg%2FFQb0J2rnhPNgqI%3Dreserved=0) > to make it easier to contribute to, easier to modify, more extensible, more > accessible, and easier to optimize for searching and performance. > > > > When I created the site, there were a couple of a factors in the design > decisions: > > > > Time - we were racing to get something done and presentable before a > conference the team was presenting at. This meant creating a site with > minimal "flare." > > Libraries - when we built the site way back then, we weren't sure what > 3rd party libraries we could incorporate. We weren't sure if Apache had > rules limiting the use of them, so we chose to use no libraries. This also > impacted the site (negatively in my opinion). > > > > Since then, we've seen other Apache sites using 3rd party libs and we > now have time to redesign the site. I propose that we redesign the site > using Hugo. This gives us the ability to utilize Markdown, which is much > more accessible for contributors, and also offers more extensibility > through themes and plugins. I think it could also make the process of > generating the docs easier but I haven't fully investigated that. > > > > Another negative about the current website is linking to content. > Because of the way that I've utilized anchors to show/hide content, this > keeps the URL slug the same no matter where you go, which makes it > difficult to share, for example, a "Getting Started" page with someone. > > > > So in summary, here are the potential benefits I see: > > + easier to modify: because the content is written in markdown, it is > easier for people change existing pages without knowledge of HTML/CSS/JS > > + easier to contribute: again, because we will use markdown for content, > it is easier for people to contribute new content > > + more extensible: because Hugo has a large ecosystem, we can tap into > the work of others > > + more accessible: this redesign will also have a focus on > accessibility so all users can engage with the content > > + better SEO: designing with SEO in mind so that users can find out > about AGE is important > > + possibly easier to build docs: right now we're using a Github workflow > to generate these, and we could possibly wrap all of this into a single > step of static site generation with Hugo > > + possible blog: another important aspect of both SEO and community > engagement is a blog, which can show examples and use cases of AGE's new > functionality with each release. The approval process for blog posts should > probably part of a separate conversation. > > > > Looking forward to hearing the community's thoughts. > > > > Thanks, > > Nick Sorrell > > > > >
Re: [DISCUSS] Website Overhaul
I think this is a great idea. The current website consists of a single HTML page, which indeed makes it more difficult to maintain, contribute to and link to content. I'm also in favor of using a static site generator to generate HTML out of Markdown. Hugo seems to be one of the most (if not the most) popular ones around, but I personally haven't used it yet. Are there examples of other Apache sites using Hugo? The documentation has already been converted to Markdown by Joe Fagan and Josh Innis. Currently, Sphinx (https://www.sphinx-doc.org/en/master/) is used to generate HTML pages. In the current setup, multiple versions of the documentation can be generated, which is not yet possible with Hugo as far as I could find (https://github.com/google/docsy/issues/114). Best regards, Pieterjan On 10.02.22 15:02, Nicholas Sorrell wrote: All, I wanted to propose that we overhaul the website (https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fincubator-age-websitedata=04%7C01%7CPieterjan.DePotter%40ugent.be%7Cffb7ffea9a1945fe276108d9ec9df500%7Cd7811cdeecef496c8f91a1786241b99c%7C1%7C0%7C637800986184870331%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000sdata=e9J1J1i%2BIcLVZ2W2KsWvwSQTOEHg%2FFQb0J2rnhPNgqI%3Dreserved=0) to make it easier to contribute to, easier to modify, more extensible, more accessible, and easier to optimize for searching and performance. When I created the site, there were a couple of a factors in the design decisions: Time - we were racing to get something done and presentable before a conference the team was presenting at. This meant creating a site with minimal "flare." Libraries - when we built the site way back then, we weren't sure what 3rd party libraries we could incorporate. We weren't sure if Apache had rules limiting the use of them, so we chose to use no libraries. This also impacted the site (negatively in my opinion). Since then, we've seen other Apache sites using 3rd party libs and we now have time to redesign the site. I propose that we redesign the site using Hugo. This gives us the ability to utilize Markdown, which is much more accessible for contributors, and also offers more extensibility through themes and plugins. I think it could also make the process of generating the docs easier but I haven't fully investigated that. Another negative about the current website is linking to content. Because of the way that I've utilized anchors to show/hide content, this keeps the URL slug the same no matter where you go, which makes it difficult to share, for example, a "Getting Started" page with someone. So in summary, here are the potential benefits I see: + easier to modify: because the content is written in markdown, it is easier for people change existing pages without knowledge of HTML/CSS/JS + easier to contribute: again, because we will use markdown for content, it is easier for people to contribute new content + more extensible: because Hugo has a large ecosystem, we can tap into the work of others + more accessible: this redesign will also have a focus on accessibility so all users can engage with the content + better SEO: designing with SEO in mind so that users can find out about AGE is important + possibly easier to build docs: right now we're using a Github workflow to generate these, and we could possibly wrap all of this into a single step of static site generation with Hugo + possible blog: another important aspect of both SEO and community engagement is a blog, which can show examples and use cases of AGE's new functionality with each release. The approval process for blog posts should probably part of a separate conversation. Looking forward to hearing the community's thoughts. Thanks, Nick Sorrell
