Skip to content

Update markdown files for preprocessing purposes #13350

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

Closed

Conversation

BarkingBad
Copy link
Contributor

No description provided.

Copy link
Contributor

@julienrf julienrf left a comment

Choose a reason for hiding this comment

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

Could you please check that the content of the files here is consistent with what we have on docs.scala-lang? I see some differences in the file other-new-features/export.md, for instance.

@BarkingBad
Copy link
Contributor Author

@julienrf I think the difference is because of #13327, I will update it asap, but currently I'm on vacations so if you'd like to merge it earlier you can take over this PR

@bishabosha
Copy link
Member

also needs updates integrated from #13328 and #13338

@BarkingBad BarkingBad force-pushed the scaladoc/md-files-for-preporcessor branch 2 times, most recently from 3ec55e9 to 40490cb Compare September 3, 2021 11:45
@BarkingBad
Copy link
Contributor Author

@bishabosha @julienrf I updated the docs, I hope now everything is up to date (I rebased on top of the current master and checked if everything is applied correctly) The faster we merge it the better, since we will avoid diverging again

Copy link
Contributor

@julienrf julienrf left a comment

Choose a reason for hiding this comment

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

If I understand correctly, this PR does two things:

  1. It overwrites the content of the .md documentation files of the dotty repository with the content of the repo docs.scala-lang,
  2. It changes the generateDocumentation task such that it only renders the API documentation (the blog and static pages are not anymore part of the output).

An important consequence is that we won’t be able to generate the dotty.epfl.ch website anymore after this PR is merged. I think this is fine, but before we do that I suggest we do a last update to clearly indicate on the website that its content is frozen/archived/unmaintained, with pointers on the place to find up to date information (on every page).

Another (annoying) thing is that we must be very careful in the way we overwrite the content of the md files. We need to make sure we don’t loose any important changes that have been applied in the dotty repository (but not in docs.scala-lang). There seems to be such changes, related to experimental features…

@bishabosha
Copy link
Member

there have been a few updates to Scala 3 docs on docs.scala-lang.org since this was last pushed

@julienrf
Copy link
Contributor

@bishabosha This is not so much a big deal, actually (I mean, this is not blocking this PR). We can pick these changes later.

@BarkingBad BarkingBad force-pushed the scaladoc/md-files-for-preporcessor branch 3 times, most recently from 5916009 to fa2df50 Compare September 16, 2021 10:16
@@ -501,6 +501,7 @@ jobs:
publish_dir: docs/_site
external_repository: lampepfl/dotty-website
publish_branch: gh-pages
keep_files: true
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe this line will preserve older static site files while publishing nightlies according to:
https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-keeping-existing-files-keep_files

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually this could not work (would overwrite top level index.html), so I updated genDocs script

@BarkingBad
Copy link
Contributor Author

I will add manually to dotty-website pregenerated static site with banners that the files are frozen since this commit.

@BarkingBad
Copy link
Contributor Author

PoC banners for files that will be moved to docs.scala-lang eventually:
obraz

Banner for all the other static site docs:
obraz

@BarkingBad
Copy link
Contributor Author

This PR scala/dotty.epfl.ch#6 should be merged right after this one. If we merge it earlier it can be overridden once nightly docs will be published.

@BarkingBad BarkingBad force-pushed the scaladoc/md-files-for-preporcessor branch from fa2df50 to 11b0f04 Compare September 17, 2021 08:51
@julienrf
Copy link
Contributor

This PR lampepfl/dotty-website#6 should be merged right after this one. If we merge it earlier it can be overridden once nightly docs will be published.

Should we consider publishing the nightly docs somewhere else than on dotty.epfl.ch? Or just make sure that they only override the API documentation, but nothing else.

I think scala/dotty.epfl.ch#6 should be merged before this PR, since this PR disables the website.

@BarkingBad
Copy link
Contributor Author

BarkingBad commented Sep 17, 2021

If we merged it, then the very first nightly of dotty would override the files with banners, thus we will lose the changes. We can create small PR with changes to the genDocs script and Build.scala so the files won't be overridden anymore, but we have to merge them at least on the same day.

@BarkingBad
Copy link
Contributor Author

Should we consider publishing the nightly docs somewhere else than on dotty.epfl.ch? Or just make sure that they only override the API documentation, but nothing else.

I think nightlies can be still published on dotty.epfl.ch, since rather there is a little traffic, most people will hit the stable docs (3.x, 3.0.2). Nonetheless, the domain is not so important in that case.

@BarkingBad
Copy link
Contributor Author

Closing since we merged #13587

@BarkingBad BarkingBad closed this Oct 1, 2021
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

Successfully merging this pull request may close these issues.

3 participants