Skip to content

Add redirections from old URLs to avoid breakages #15118

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

Merged
merged 2 commits into from
May 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ subsection:
- page: reference/metaprogramming/reflection.md
- page: reference/metaprogramming/tasty-inspect.md
- title: Other New Features
index: reference/other-new-features/other-new-types.md
index: reference/other-new-features/other-new-features.md
subsection:
- page: reference/other-new-features/trait-parameters.md
- page: reference/other-new-features/transparent-traits.md
Expand Down
12 changes: 12 additions & 0 deletions project/Build.scala
Original file line number Diff line number Diff line change
Expand Up @@ -1381,21 +1381,33 @@ object Build {
generateDocumentation(Testcases)
}.value,

// Generate the Scala 3 reference documentation (published at https://docs.scala-lang.org/scala3/reference)
generateReferenceDocumentation := Def.inputTaskDyn {
val shouldRegenerateExpectedLinks = (Space ~> literal("--no-regenerate-expected-links")).?.parsed.isEmpty

generateStaticAssetsTask.value

// Move all the source files to a temporary directory and apply some changes specific to the reference documentation
val temp = IO.createTemporaryDirectory
IO.copyDirectory(file("docs"), temp / "docs")
IO.delete(temp / "docs" / "_blog")

// Overwrite the main layout and the sidebar
IO.copyDirectory(
file("project") / "resources" / "referenceReplacements",
temp / "docs",
overwrite = true
)

// Add redirections from previously supported URLs, for some pages
for (name <- Seq("changed-features", "contextual", "dropped-features", "metaprogramming", "other-new-features")) {
val path = temp / "docs" / "_docs" / "reference" / name / s"${name}.md"
val contentLines = IO.read(path).linesIterator.to[collection.mutable.ArrayBuffer]
contentLines.insert(1, s"redirectFrom: /${name}.html") // Add redirection
val newContent = contentLines.mkString("\n")
IO.write(path, newContent)
}

val languageReferenceConfig = Def.task {
Scala3.value
.add(OutputDir("scaladoc/output/reference"))
Expand Down
2 changes: 1 addition & 1 deletion project/resources/referenceReplacements/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ subsection:
- page: reference/metaprogramming/reflection.md
- page: reference/metaprogramming/tasty-inspect.md
- title: Other New Features
index: reference/other-new-features/other-new-types.md
index: reference/other-new-features/other-new-features.md
subsection:
- page: reference/other-new-features/trait-parameters.md
- page: reference/other-new-features/transparent-traits.md
Expand Down