-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
get-wpe.md: newly organized content on how to get WPE #189
Conversation
What still needs to be done here:
|
I think the preview linked above is not really working, so please don't rely on it to analyze the site. Best to download and deploy locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a general comment that I would rather not block anything on but would like to point out that we had a page with all of this stuff on it once and we kind of moved away from that ... I do think that ultimately we need to pick whether the different personas served by the categories of headings here are better served by a single big page like this or 2 or even 3. I'm honestly ok with any answer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The underlying issue is that the website as is is poor and confusing, there's some info scattered here and there but very vague and lacks substance, information can be redundant, difficult to find, inconsistently placed, or in some cases just boilerplate that doesn't really tell much of use. I am trying to remedy that, starting with the get started/get wpe page. We need better resources on how to get the project, and the current page does not really help anyone to find out how to do it. Since there is not a one-solution-fits-all answer (nor should be), we need to cover these different options.
I understand that there was (or is?) a concept of having a site that serves different personas, and all that, but I don't see that reflected in the site. This could be done, of course, but I am afraid that it's not really happening and what we have in the meantime is just vague and hard-to-find information scattered around. I'm concerned with fixing the latter problem first and foremost.
|
||
## Before starting | ||
|
||
Before getting the code, it's a good idea to be familiar with what you |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My only real comment here is that are we sure about this particular organization of the page? That is: Do you need to know any of this if you're here to get a distro? I don't think so, right? I guess it doesn't hurt but it implies you might need to install something else and I think in that case, or in the balena case (if we keep it) you don't?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, you have to install several packages if you're going the distro way. If you don't know that, you might just try to find the "one" WPE package, which is not guaranteed to exist.
If you are going to use a more involved setup, you should also have a vague idea of what packages you are going to be dealing with. I don't see any scenario involving getting your hands on WPE where knowing this will not be useful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am generally ok with this and I think it is an ok iteration which perhaps can stand some more still. I left a couple of comments.
8f5851e
to
6e172a4
Compare
bd52bf9
to
ad31b81
Compare
@csaavedra I think this PR needs rebasing. Once that's ready it would be great if @bkardell and/or @meyerweb could take another look and merge it if looking good, to avoid having this hanging around for a few weeks more. FWIW, this is how it looks now: Personally, I think this is good enough already, but again I should not be the one reviewing this 😇 |
I hit the rebasing button and it seems not to have broken anything (which is unusual for me, let’s be honest). This looks good to me to merge, personally. It will require a small edit to my “link-line-to-CTA-button” PR, but nothing major. |
This is a major rewrite of the contents of explore-wpe.md and code.md (which is unlisted currently and unreachable). The approach is to first introduce the components that form WPE (cog, libwpe, etc) and then offer the different ways to get it, going from the easiest to the most complex method. For consistency, rename it from "explore WPE" to "Get WPE", since this is what this page is about. Also make sure that all links pointing to this page explain what it is about. Last but no least, I removed links to the yocto webkit layer from the Learn&Discover page, as this is already offered in the "Get WPE" page, to avoid redundance. The "Code" page still needs to be removed, but I will do that in a subsequent MR when I get to reorganize the contents of the "Developers" section.
76d9970
to
da14902
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this looks good now too, let's get it in and fix things later on if we are not fully happy.
Otherwise we're postponing this forever, and I think what we got now is already a net positive.
@csaavedra I think we can also provide another PR to remove https://wpewebkit.org/code/, which is a dead link now anyway |
If you or @meyerweb (or anyone else) can provide a MR to remove that, that could be merged rightaway |
Closes #188 This is basically the fix implemented in [1], which was rendered useless after PR #189 [2] got merged, so this is a quick fix. [1] #191 [2] #189 Site preview: https://igalia.github.io/wpewebkit.org/issue-188-v2
@csaavedra @meyerweb Unless I'm missing something obvious, I can't see any other reference to the code/ page other than the mere presence of the code.md file itself, so here is a PR: #193 |
Closes #188 This is basically the fix implemented in [1], which was rendered useless after PR #189 [2] got merged, so this is a quick fix. [1] #191 [2] #189 Site preview: https://igalia.github.io/wpewebkit.org/issue-188-v2
This is a major rewrite of the contents of explore-wpe.md and code.md (which is unlisted currently and unreachable). The approach is to first introduce the components that form WPE (cog, libwpe, etc) and then offer the different ways to get it, going from the easiest to the most complex method.
For consistency, rename it from "explore WPE" to "Get WPE", since this is what this page is about. Also make sure that all links pointing to this page explain what it is about.
Last but no least, I removed links to the yocto webkit layer from the Learn&Discover page, as this is already offered in the "Get WPE" page, to avoid redundance.
The "Code" page still needs to be removed, but I will do that in a subsequent MR when I get to reorganize the contents of the "Developers" section.
Site preview: https://igalia.github.io/wpewebkit.org/csaavedra/get-wpe.md/