-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Update markdown files for preprocessing purposes #13350
Conversation
There was a problem hiding this 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.
3ec55e9
to
40490cb
Compare
@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 |
There was a problem hiding this 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:
- It overwrites the content of the .md documentation files of the dotty repository with the content of the repo docs.scala-lang,
- 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…
there have been a few updates to Scala 3 docs on docs.scala-lang.org since this was last pushed |
@bishabosha This is not so much a big deal, actually (I mean, this is not blocking this PR). We can pick these changes later. |
5916009
to
fa2df50
Compare
.github/workflows/ci.yaml
Outdated
@@ -501,6 +501,7 @@ jobs: | |||
publish_dir: docs/_site | |||
external_repository: lampepfl/dotty-website | |||
publish_branch: gh-pages | |||
keep_files: true |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
I will add manually to |
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. |
fa2df50
to
11b0f04
Compare
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. |
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 |
I think nightlies can be still published on |
Closing since we merged #13587 |
No description provided.