Skip to content
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

Please reveal the source/mechanics of the alex and happy subsites #183

Closed
andreasabel opened this issue Feb 23, 2022 · 23 comments
Closed

Please reveal the source/mechanics of the alex and happy subsites #183

andreasabel opened this issue Feb 23, 2022 · 23 comments

Comments

@andreasabel
Copy link
Contributor

There is no information on what alex/ or happy/ redirect to, and where their source is hosted.

www.haskell.org/README.md

Lines 149 to 150 in 087e788

* <a name="details-alex"></a>
`alex/`

Context:

@tomjaguarpaw
Copy link
Collaborator

tomjaguarpaw commented Feb 23, 2022

The sources are not known, and the mechanics of how they are hosted are that they are just HTML files on the www.haskell.org server. I'm not sure who, if anyone, knows more than that. Maybe Simon Marlow? In any case there is no well-understood procedure for updating them or for granting the authority for them to be updated. (Highlighting this is part of the reason I made the subsites table in the first place.)

@andreasabel
Copy link
Contributor Author

Thanks @tomjaguarpaw for the quick reply! So likely it is @simonmar who has been handling this.

HTML files on the www.haskell.org server.

If I wanted access to this server, how would I go about?

@tomjaguarpaw
Copy link
Collaborator

So likely it is @simonmar who has been handling this.

Yes, but perhaps last 10 years ago.

If I wanted access to this server, how would I go about?

Taking your question literally, I think you would have to be elected to the Haskell.org committee, become a Haskell Infrastructure admin, or some other how have the admins grant you access.

But if you're asking because you want to change the alex/ and happy/ subsites, the most direct route is probably to lobby various stakeholders to persuade them that a change is warranted, and then submit a PR to www.haskell.org to change them to something else. It doesn't really matter where the old source is, given that we can just replace it with something else.

@gbaz
Copy link
Contributor

gbaz commented Feb 23, 2022

The easiest way to get access to maintain any subsite is to show "hey, an existing person responsible for the project/site has said I should have access" and the admins will hook you up immediately.

There's nothing in the least confusing or difficult about it. We do it frequently. I don't know why people insist on believing that it is at all hard or time consuming.

@tomjaguarpaw
Copy link
Collaborator

@gbaz I'm not sure exactly what you're responding to. I'm sorry if I gave you the impression that I think the infra-admins make things slow or time-consuming. That's not what I meant. Actually, what is difficult is finding out who is responsible for the project and convincing them to do anything about the current state of their project subsite.

For example, it took nearly six months (Dec 20 - May 21) for me to get some small, uncontroversial, PRs merged into the cabal subsite [example]. I guarantee to you that I found that confusing, difficult, hard and time consuming. In fact I found the whole process so absurdly frustrating that I joined the Haskell.org committee to try to help improve things.

Now, again, I don't blame the infra-admins for this. Who is to blame? Well, it's not really clear, because there is a vast void of authority, leadership, responsibility, initiative and accountability around most of the www.haskell.org subsites. That is the problem.

@gbaz
Copy link
Contributor

gbaz commented Feb 23, 2022

I see your point. The problem there is you were trying to get someone else to update the site, and nobody was stepping up to do it, and so it languished. Getting permission to update the site yourself by volunteering is in that sense much easier.

@tomjaguarpaw
Copy link
Collaborator

tomjaguarpaw commented Feb 23, 2022

Well then, I think one answer to @andreasabel's question is:

You ask John Ericson @Ericson2314 and Vladislav Zavialov @int-index (the only active maintainers of happy and alex) to share with you their authority over those subsites. Then you can do with it as you wish. I suggest you do one of the following:

  • Ask the infra-admins to establish redirects from the subsite to a separately-maintained up-to-date alternative (for example on readthedocs.io) (this is the option chosen by Haddock)

  • Move the subsite into the www.haskell.org repo (then it can be kept up-to-date by our normal PR, CI and deploy process)

@ghost
Copy link

ghost commented Feb 24, 2022

for example on readthedocs.io

maybe not a good fit as per #195

alex webpage has link Online (HTML)

happy webpage has link Online Documentation

code for respective packages' User Guide(s) not written in .rst files

@andreasabel
Copy link
Contributor Author

@gbaz

The easiest way to get access to maintain any subsite is to show "hey, an existing person responsible for the project/site has said I should have access" and the admins will hook you up immediately.

I sent my SSH key to @bgamari in reference to haskell/happy#122 (comment).
Should I send it to you as well/instead?

@gbaz
Copy link
Contributor

gbaz commented Feb 24, 2022

Ben, davean or myself can do it for you. Typically one emails admin at haskell dot org to get in contact with the admin group. That said, it would be good to have some indication of signoff from a current maintainer of these packages that they're aware of this and fine with you getting upload permissions.

@ketzacoatl
Copy link
Contributor

@andreasabel / @tomjaguarpaw, would this not be a great place to use CI to build and update the contents of the site for us? Why are we limited to SSH and manual file uploads for managing this content?

@gbaz
Copy link
Contributor

gbaz commented Mar 27, 2022

to close this out, ben, andreas, and john now all have ssh perms for the two subsites.

@tomjaguarpaw
Copy link
Collaborator

would this not be a great place to use CI to build and update the contents of the site for us?

Yes it would. I would be happy to incorporate the happy and alex subsites into the main www.haskell.org repo so it can take advantage of our CI and automated deployment. That decision is up to the subsite owners though.

Why are we limited to SSH and manual file uploads for managing this content?

Well, I suppose because it requires work and buy-in to do anything different.

@ketzacoatl
Copy link
Contributor

That decision is up to the subsite owners though.

Good point, who are the owners / who do we speak to? Is this for the CLC to consider?

@tomjaguarpaw
Copy link
Collaborator

who are the owners / who do we speak to? Is this for the CLC to consider?

It's not the CLC. In practical terms it's the people that gbaz named at #183 (comment)

@tomjaguarpaw
Copy link
Collaborator

That is, Ben Gamari, Andreas Abel, John Ericsson.

@ghost
Copy link

ghost commented Mar 29, 2022

haskell/alex#204 (comment)

friendly reminder if anyone wants to use the code from a validated update

@andreasabel
Copy link
Contributor Author

I now added source info for /alex:

@tomjaguarpaw wrote:

would this not be a great place to use CI to build and update the contents of the site for us?

Yes it would. I would be happy to incorporate the happy and alex subsites into the main www.haskell.org repo so it can take advantage of our CI and automated deployment. That decision is up to the subsite owners though.

Speaking for alex (where I am currently working on website/docs), I'd be happy to follow your suggestion. I suppose I could get edits in via simple PRs then. Atm, /alex is just one index.html file (which does not contain anything that could not also live in the docs).
See also

where I suggest to make /alex a simple redirect to the docs hosted on RTD.

@tomjaguarpaw
Copy link
Collaborator

I suppose I could get edits in via simple PRs then

Yes, exactly. Everything is very nicely set up with CI automatically deploying to the server.

@tomjaguarpaw
Copy link
Collaborator

@andreasabel I believe this issue has been resolved. If so, please close. If not, please clarify. Otherwise I'll close this as a formality in due course.

@Ericson2314
Copy link
Contributor

Ericson2314 commented Nov 6, 2022

I have now converted the Happy docs to https://haskell-happy.readthedocs.io so we may want to do a redirect for Happy and Alex alike.

In the interim I would be happy to see the HTML just put in this repo instead, while we do a final pass to make sure the docs have everything in the website or similar.

@tomjaguarpaw
Copy link
Collaborator

In the interim I would be happy to see the HTML just put in this repo instead, while we do a final pass to make sure the docs have everything in the website or similar.

Great, thanks! Sounds like a good solution to me. Please drive forward those PRs :)

@TikhonJelvis
Copy link
Member

Thanks for looking into this! I'm assuming that #225 and #226 address this; if we need to do more, we can reopen this issue or open a new one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants