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

Update the installation instructions. #125

Merged
merged 4 commits into from
May 5, 2024
Merged

Update the installation instructions. #125

merged 4 commits into from
May 5, 2024

Conversation

kape1395
Copy link
Collaborator

Fixes #123.

Fixes #123.

Signed-off-by: Karolis Petrauskas <[email protected]>
@kape1395
Copy link
Collaborator Author

@ahelwer, may I ask you to check if the installation-related changes in the documentation look good to you?
Also, it would be awesome if you added an upload of the docs to the Inria server. If I understand correctly, tlaplus repo does that; maybe tlapm could be done similarly.

@ahelwer
Copy link
Collaborator

ahelwer commented Apr 22, 2024

Sure, I will test the installation docs tomorrow!

For uploading the docs to the INRIA server what do you mean exactly?

@kape1395
Copy link
Collaborator Author

For uploading the docs to the INRIA server what do you mean exactly?

Docs from https://github.com/tlaplus/tlapm/tree/main/doc/web have to be published somehow at https://tla.msr-inria.inria.fr/tlaps/. That should be done in the CI (maybe on a release, not each commit). Such publishing is done for tlaplus here: https://github.com/tlaplus/tlaplus/blob/03c7bf4f35ccf1217ac2c53e5bf60d1220c8b0d8/.github/workflows/main.yml#L180. Maybe TLAPM CI scripts should be updated similarly.

@ahelwer
Copy link
Collaborator

ahelwer commented May 2, 2024

@kape1395 the docs website is now served using github pages from the main branch of this repo at https://proofs.tlapl.us

@kape1395
Copy link
Collaborator Author

kape1395 commented May 3, 2024

@ahelwer, thanks for the update! Maybe you have reviewed the changes to the installation instructions?

@lemmy, we should redirect somehow https://tla.msr-inria.inria.fr/tlaps/ to https://proofs.tlapl.us/, otherwise it will be confusing to have two sites for docs. Only the first one is suggested by google, for me at least.

@lemmy
Copy link
Member

lemmy commented May 3, 2024

@lemmy, we should redirect somehow https://tla.msr-inria.inria.fr/tlaps/ to https://proofs.tlapl.us/, otherwise it will be confusing to have two sites for docs. Only the first one is suggested by google, for me at least.

Done:

root@tla:/etc/apache2/sites-enabled# tail -7 default-ssl.conf

	Redirect 301 /tlaps https://proofs.tlapl.us/

	</VirtualHost>
</IfModule>

@kape1395
Copy link
Collaborator Author

kape1395 commented May 3, 2024

@lemmy, this works partially. Paths are different, redirects should consider this, IMO. For example Google suggests https://tla.msr-inria.inria.fr/tlaps/content/Download/Binaries.html

Which is redirected to https://proofs.tlapl.us//content/Download/Binaries.html and gets 404.
It should be redirected to https://proofs.tlapl.us/doc/web/content/Download/Binaries.html (consider doc/web in the path).

@lemmy
Copy link
Member

lemmy commented May 3, 2024

Do you know how to set this up in Apache 2?

@kape1395
Copy link
Collaborator Author

kape1395 commented May 3, 2024

Maybe it is enough to replace

Redirect 301 /tlaps https://proofs.tlapl.us/

with

Redirect 301 /tlaps https://proofs.tlapl.us/doc/web

?

@lemmy
Copy link
Member

lemmy commented May 3, 2024

Please try again and let me know:

root@tla:/etc/apache2/sites-enabled# tail -7 default-ssl.conf

	Redirect 301 /tlaps https://proofs.tlapl.us/doc/web

	</VirtualHost>
</IfModule>

@kape1395
Copy link
Collaborator Author

kape1395 commented May 3, 2024

Looks good now. Thanks!

@@ -21,158 +21,33 @@
<h2>Generic Instructions</h2>

<p>These instructions apply to any UNIX-like system, including
GNU/Linux, most BSD variants, Solaris, Cygwin on Windows,
GNU/Linux, most BSD variants, Solaris, WSL and Cygwin on Windows,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to remove mention of Cygwin here and focus on WSL support?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I removed the mention of Cygwin.

@@ -21,25 +21,25 @@ <h2><img class="blogo" src="images/logo_linux35.png"
alt="[Tux]"/>Linux</h2>
<p class="first"> The package:
<code><a type="application/x-executable"
href="https://github.com/tlaplus/tlapm/releases/latest/download/tlaps-1.4.5-x86_64-linux-gnu-inst.bin">tlaps-1.4.5-x86_64-linux-gnu-inst.bin</a></code>
href="https://github.com/tlaplus/tlapm/releases/download/202210041448/tlaps-1.5.0-x86_64-linux-gnu-inst.bin">tlaps-1.5.0-x86_64-linux-gnu-inst.bin</a></code>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the (near) future when we switch to a rolling release model I suppose we will want to use the /latest/ tag along with a link to a binary that does not have the version in the name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. This will have to be changed in the future.
For now, I just wanted to keep links valid after a new release is made.

@kape1395
Copy link
Collaborator Author

kape1395 commented May 4, 2024

@lemmy, @ahelwer, the MacOS version cannot be built anymore.
The scripts refer to macos-latest, and it points now to macos-14-arm64. It was macos-12 in the latest successful build.

The old Isabelle (2011) does not work with the ARM chips.
The new Isabelle (2024) is in progress. All the non-skipped proofs in the Examples repo have been built successfully, but some degradations still exist (it looks like something with integers/naturals).

The question:

@ahelwer
Copy link
Collaborator

ahelwer commented May 4, 2024

Can we split the macOS build into intel and arm64?

@kape1395
Copy link
Collaborator Author

kape1395 commented May 4, 2024

I think we will have to. Maybe for now, we can stick to macos-13 for the Intel version?
See https://github.com/actions/runner-images?tab=readme-ov-file#available-images

@ahelwer
Copy link
Collaborator

ahelwer commented May 4, 2024

Is there a way to do cross-compilation instead of having to run the build on an intel mac?

@kape1395
Copy link
Collaborator Author

kape1395 commented May 4, 2024

I don't know; I never tried to do that.

@lemmy
Copy link
Member

lemmy commented May 4, 2024

@kape1395
Copy link
Collaborator Author

kape1395 commented May 5, 2024

It works with macos-13, so I'll keep it like this for now.

@kape1395 kape1395 merged commit 8facb9a into main May 5, 2024
5 checks passed
@kape1395 kape1395 deleted the docs-install branch August 18, 2024 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Binary installer links on the TLAPS website are broken
3 participants