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

Restructure JVM docs. #20544

Merged
merged 4 commits into from
Feb 17, 2024
Merged

Restructure JVM docs. #20544

merged 4 commits into from
Feb 17, 2024

Conversation

benjyw
Copy link
Contributor

@benjyw benjyw commented Feb 14, 2024

Previously the top-level menu was called
"Java and Scala" and "Kotlin" was a subpage.

Now the top-level is called "JVM" and there
are two subpages - "Java and Scala", and "Kotlin".

Copy link
Contributor

@huonw huonw left a comment

Choose a reason for hiding this comment

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

Sensible rearrangement!

I think this rename will mean existing links to https://www.pantsbuild.org/2.19/docs/java-and-scala and https://www.pantsbuild.org/2.19/docs/java-and-scala/kotlin will be broken, so it may be best to either:

@thejcannon
Copy link
Member

FWIW let's use a new file for new redirects. I'm hoping to keep that file strictly old -> new (simply for separations sake)

@benjyw
Copy link
Contributor Author

benjyw commented Feb 14, 2024

Good idea re the redirects. So, how do I preview all this? Once I know how I will document it somewhere central.

@thejcannon
Copy link
Member

Generally, I would make edits on pantsbuild.org repo, then you can iterate. When you feel good about it, I'd cp back to this repo and PR

Previously the top-level menu was called
"Java and Scala" and "Kotlin" was a subpage.

Now the top-level is called "JVM" and there
are two subpages - "Java and Scala", and "Kotlin".
@benjyw benjyw force-pushed the restructure_jvm_docs branch from 67988f3 to 844e6ad Compare February 16, 2024 23:09
@benjyw benjyw added this to the 2.19.x milestone Feb 17, 2024
@benjyw benjyw removed this from the 2.19.x milestone Feb 17, 2024
@benjyw
Copy link
Contributor Author

benjyw commented Feb 17, 2024

I have a redirects PR ready in pantsbuild/pantsbuild.org. IIUC, we can merge it once this is merged, since the redirecting files will only be created when we publish.

@benjyw benjyw added this to the 2.19.x milestone Feb 17, 2024
@benjyw benjyw merged commit decfe2d into pantsbuild:main Feb 17, 2024
24 checks passed
@benjyw benjyw deleted the restructure_jvm_docs branch February 17, 2024 06:13
WorkerPants pushed a commit that referenced this pull request Feb 17, 2024
Previously the top-level menu was called
"Java and Scala" and "Kotlin" was a subpage.

Now the top-level is called "JVM" and there
are two subpages - "Java and Scala", and "Kotlin".
WorkerPants pushed a commit that referenced this pull request Feb 17, 2024
Previously the top-level menu was called
"Java and Scala" and "Kotlin" was a subpage.

Now the top-level is called "JVM" and there
are two subpages - "Java and Scala", and "Kotlin".
@WorkerPants
Copy link
Member

I tried to automatically cherry-pick this change back to each relevant milestone, so that it is available in those older releases of Pants.

✔️ 2.19.x

Successfully opened #20565.

✔️ 2.20.x

Successfully opened #20564.


Thanks again for your contributions!

🤖 Beep Boop here's my run link

benjyw added a commit to benjyw/pantsbuild.org that referenced this pull request Feb 17, 2024
benjyw added a commit that referenced this pull request Feb 19, 2024
Previously the top-level menu was called
"Java and Scala" and "Kotlin" was a subpage.

Now the top-level is called "JVM" and there
are two subpages - "Java and Scala", and "Kotlin".

Co-authored-by: Benjy Weinberger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants