[1.x] 1.x documentation updates targeting develop branch are not reflected on the website

[Friendseeker]

steps

Open a random page in sbt documentation, e.g. https://www.scala-sbt.org/1.x/docs/GitHub-Actions-with-sbt.html#Read+the+GitHub+Actions+manual

problem

The documentation updates in develop branch are not reflected in the documentation. (e.g. above page does not contain #1216)

expectation

The documentation updates in develop branch should be reflected on the documentation website.

[Friendseeker]

Reading https://github.com/sbt/sbt.github.com and I guess it is not as straightforward as letting 1.x doc changes in develop branch to be reflected.

The way sbt's official website publishing works is that each branch in sbt-website associates to an sbt version, and the website is then built & pushed into the associated folder in https://github.com/sbt/sbt.github.com/tree/master

website/project/Docs.scala

Lines 296 to 300 in accb75e

	def customGhPagesSettings: Seq[Setting[_]] = GhpagesPlugin.ghpagesProjectSettings ++ Seq(
	git.remoteRepo := "[email protected]:sbt/sbt.github.com.git",
	ghpagesUpdatedRepository / GitKeys.gitBranch := Some("master"),
	ghpagesSynchLocal := syncLocalImpl.value
	)

So I guess what we should actually do is:

• Backport all 1.x documentation updates from develop branch to 1.x branch
• Backport the scala-cla & setup-sbt fixes from develop branch to 1.x branch
• Delete all 1.x documentation files in develop branch to avoid future accidental 1.x documentation updates targeting develop branch
• Update README to make things clear that 1.x branch contains (and only contains) 1.x documentation, and develop branch contains (and only contains) 2.x documentation. 1.x contributions should target 1.x branch and vice versa

@eed3si9n What do you think? Do you think this is the way to move forward?

[eed3si9n]

We are still working on sbt 2.x docs so I'm sort of keeping doc files around from 1 as raw material, so I can keep the git lineage / git blame when I reuse some of the contents.