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

Documentation does not seem to update for each main branch push. #367

Closed
jonathan-dilorenzo opened this issue Nov 22, 2021 · 10 comments
Closed
Assignees

Comments

@jonathan-dilorenzo
Copy link
Contributor

In the main readme, it says: "[The documentation] is updated every time a new commit is pushed to the main branch."

I just noticed that this does not seem to be happening automatically since the last documentation update was in early July.

@antoninbas
Copy link
Member

Thanks for reporting this @jonathan-dilorenzo. I will look into this. Unfortunately it seems that the source for the p4.org website is no longer hosted in this Github organization, as the https://github.com/p4lang/p4lang.github.io repo is tagged as deprecated.

@antoninbas antoninbas self-assigned this Nov 30, 2021
@jfingerh
Copy link

jfingerh commented Nov 6, 2022

Antonin and I have been discussing this in the past week or so. I am in contact with a maintainer of the P4.org web site at ONF that might be able to help update the "working draft" links so they actually point at the latest auto-generated versions, instead of whatever they point at now. Stay tuned.

@smolkaj
Copy link
Member

smolkaj commented Nov 7, 2022

Thanks for looking into this. This seems like a really important issue to fix.

@jafingerhut
Copy link
Contributor

OK, we are getting close. Here is a personal test web page that has the current links to the latest released versions from the https://p4.org/specs/ page, and copies of the currently wrong/bad "working draft" links, plus "proposed new links" that are working, thanks to the efforts of Antonin Bas, Nate Foster, and myself: https://jafingerhut.github.io/p4-specs/p4-specification-documents.html

Please do not pass this page around, as it might be deleted soon, but we do hope to get these "proposed new links" installed in the appropriate places on the p4.org/specs page soon.

Yay! Progress!

@jnfoster
Copy link

jnfoster commented Nov 9, 2022

"Always bet on JS" :-)

@jnfoster
Copy link

jnfoster commented Nov 9, 2022

Minor, but I'd suggest updating with the final versions that I sent to Denise. They are pure JS and don't even use JQuery. Being leaner and meaner, they should be less prone to bit-rot.

HTML

<!DOCTYPE html>
<html>
<head>
<script>
const url = "https://raw.githubusercontent.com/p4lang/p4-spec/gh-pages/docs/P4-16-working-spec.html";  
const req = new XMLHttpRequest();
req.open("GET", url, true);
req.onload = (_) => {
    const doc = document.open("text/html", "replace");
    doc.write( req.response );
    doc.close();
};
req.send(null)
</script>
</head>
<body></body>
</html>

PDF

<!DOCTYPE html>
<html>
<head>
<script>
const url = "https://raw.githubusercontent.com/p4lang/p4-spec/gh-pages/docs/P4-16-working-spec.pdf";
const req = new XMLHttpRequest();
req.open("GET", url, true);
req.responseType = "arraybuffer";
req.onload = (_) => {
  const blob = new Blob([new Uint8Array(req.response)], { type: "application/pdf" });
  var newUrl = URL.createObjectURL(blob);
  window.location.href = newUrl;
};
req.send(null);
</script>
</head>
<body>
</body>
</html>

@smolkaj
Copy link
Member

smolkaj commented Nov 9, 2022 via email

@jafingerhut
Copy link
Contributor

Thanks for noticing, Nate. I got your latest email with those versions, but somehow copied the one that was one version older. Updated now.

@jafingerhut
Copy link
Contributor

The links on this page are now good: https://p4.org/specs/

This PR should, I believe, make the working draft links in this repo's README also point at the same places: #402

@jonathan-dilorenzo
Copy link
Contributor Author

Amazing, thanks so much for fixing this!

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