Rewrite Governance #613
Closed
Rewrite Governance #613
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
The CI keeps failing because ocamlformat wants to reformat the branches. This PR applies that formatting which should help keep CI consistently succeeding.
The book website is gone and the shop that used to sell it doesn't seem to have it on its website any more either.
The other links already use "Read Online" phrasing, so it is nice to be consistent and also the text is slightly shorter.
Some of the books have multiple links, it would be nice to display them all
This adds syntax completion and syntax error highlighting through merlin-js. Merlin is introduced in a separate worker that is initialized asynchronously so as to not delay the first paint. We updated the code-mirror bindings to support the features required by merlin-js. The existing top-level worker is not initialized after the first paint. Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
- Ocamlorg_package.Documentation.item is now a polymorphic variant, to ease rendering the items in eml - Add breadcrumbs.eml as a component rendering navigation breadcrumbs - Update handler.ml, package_documentation.eml and package_layout.eml to render the breadcrumbs Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
merlin-js also has a pin-depends on jsoo-code-mirror, and it seems that we need the same in ocamlorg: https://deploy.ci.ocaml.org/job/2022-08-09/145812-ocluster-build-bdf2ff
Signed-off-by: Paul-Elliot <peada@free.fr> Co-authored-by: Christine Rose <christinerose@users.noreply.github.com> Co-authored-by: Sonja Heinze <sonjaleaheinze@gmail.com>
Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
Made a small change to help fix the `Unbound module` error. It should be mentioned that the order of files given to the compiler is important. ```ocamlopt -o hello bmodule.ml amodule.ml``` instead of ```ocamlopt -o hello amodule.ml bmodule.ml``` will result in an `Unbound module` error. Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Co-authored-by: Christine Rose <professor.rose@gmail.com> Co-authored-by: Paul-Elliot <peada@free.fr> Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com> Co-authored-by: Jules Aguillon <jules@j3s.fr>
Co-authored-by: Gabriel Scherer <gabriel.scherer@gmail.com>
Signed-off-by: Paul-Elliot <peada@free.fr> Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Signed-off-by: Paul-Elliot <peada@free.fr> Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: Paul-Elliot <peada@free.fr>
Display links to change log, readme, license in package overview. Also displays licence name. Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com> Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
…575) Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
ahrefs reports https pages should avoid having links to the same
domain using http urls. Here are the commands executed:
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(ocaml.org\)/https:\/\/\1/g" "{}" ";"
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(www.ocaml.org\)/https:\/\/\1/g" "{}" ";"
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(lists.ocaml.org\)/https:\/\/\1/g" "{}" ";"
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(opam.ocaml.org\)/https:\/\/\1/g" "{}" ";"
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(tools.ocaml.org\)/https:\/\/\1/g" "{}" ";"
find . -name "*.md" -exec sed "-i" "s/http:\/\/\(discuss.ocaml.org\)/https:\/\/\1/g" "{}" ";"
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
The anchor of h1,h2,h3,h4,h5,h6 "fully covers" the heading, so the user can click on the heading to get a link to that particular section. The targeted section is now highlighted (like a text marker) to make it easier for the recipient of a targeted link to see which section they are being referred to. Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
…heir sub-pages (#581) * factoring out shared elements between 'Learn' page and 'Exercises' page: `Learn_layout` now exports functions that render the links and link groups, as well as the icon link group of the sidebar * refactoring Learn_layout.eml into a layout component * "Documentation" in sidebar is now "Learn OCaml" * minor style improvements Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
* omit breadcrumbs on package docs when there are is no hierarchy (i.e. no libraries) * don't render breadcrumbs when the path is empty - to avoid unnecessary whitespace Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
Co-authored-by: Sabine Schmaltz <sabine@tarides.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: Christine Rose <christinerose@users.noreply.github.com> Co-authored-by: Anil Madhavapeddy <anil@recoil.org>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com> Co-authored-by: Christine Rose <christinerose@users.noreply.github.com>
Pages accessible using different URLs shall include a canonical link, indicating which URL is the best (search Google for “consolidate duplicates URLs”). This is useful for web crawlers. Ahrefs reports “Duplicate pages without canonical” as an issue. This patch adds canonical links to several pages. Main tag generation takes place in layout.eml. Often, it is sufficient to pass the right URL to `Layout.render`. This is the case for: * about.eml * academic_users.eml * best_pratices.eml * blog.eml * books.eml * community.eml * industrial_users.eml * jobs.eml * learn.eml * news.eml * packages.eml * papers.eml * platform.eml * problems.eml * releases.eml * tutorial.eml A few others are almost the same, except some obvious path part needs to be appended. This is the case for: * news_post.eml * release.eml * success_story.eml * workshop.eml Other changes include parameter forwarding: * learn_layout.eml * ocamlorg_frontend.ml * page.eml * tutorial.eml In home.eml, the empty string is used to have "https://ocaml.org" be the best URL (without trailing slash) In handler.ml a combination of parameter forwarding and canonical URL setting takes place. In playground.eml, the string "https://ocaml.org" is hardwired a second time because it uses an ad-hoc layout. No canonical link is generated in not_found.eml, on purpose.
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: David Allsopp <david.allsopp@metastack.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Co-authored-by: tmattio <tmattio@users.noreply.github.com>
Co-authored-by: Asaad Mahmood <asaadmahmood@users.noreply.github.com> Co-authored-by: MirzaBabarBaig <mirza.babar35@gmail.com>
Removes almost duplicated code and small performance improvement
Mailing lists and the ocaml/infrastructure no longer seem to be accurate information. This will need update.
Some of the original text was lost. https://gist.github.com/amirmc/fe8a931c246bb13d9b32
* Extend the scope of the governance to the current ecosystem including GitHub. Project no longer mean ocaml.org subdomain. In this version, a Project is either a subdomain or a GitHub project. However, it may make sense to have Projects without any of those two. * Mark obviously obsolete stuff with ~~strikethough~~ This is mostly related to communication. The infrastructure mailing list never seem to have worked well. Discuss is not mentionned.
|
Staging needs to be updated first, otherwise, there are way too many commits. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
updated_atfield from watch.ocaml.org scraping (Removeupdated_atfield from watch.ocaml.org scraping #545)Unbound moduleerror (Compilation: order of source files matter. #556)