Skip to content
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

Rework site documentation #4544

Merged
merged 1 commit into from
Dec 27, 2024
Merged

Rework site documentation #4544

merged 1 commit into from
Dec 27, 2024

Conversation

Bananeweizen
Copy link
Contributor

  • fix wording and typos
  • enable syntax highlighting
  • replace tabs in code blocks for unified layout
  • upgrade skin (dependabot doesn't work for site.xml)

Be aware numbered lists don't work well here, if they have code blocks in between, because the index resets to 1 after each block. Therefore numbered lists have been replaced by bullet lists several times. An alternative might be converting to Asciidoc, which has far greater control over such things.

Copy link

github-actions bot commented Dec 18, 2024

Test Results

  603 files  ±0    603 suites  ±0   4h 19m 1s ⏱️ + 11m 33s
  432 tests ±0    422 ✅  - 2   7 💤 ±0  2 ❌ +1  1 🔥 +1 
1 296 runs  ±0  1 270 ✅  - 3  22 💤 ±0  3 ❌ +2  1 🔥 +1 

For more details on these failures and errors, see this check.

Results for commit 1facd06. ± Comparison against base commit edb9113.

♻️ This comment has been updated with latest results.

@laeubi
Copy link
Member

laeubi commented Dec 20, 2024

@Bananeweizen can you share a screenshot of the new layout/skin?

@Bananeweizen
Copy link
Contributor Author

Bananeweizen commented Dec 20, 2024

@laeubi The skin itself is the exact same. This shows left=online documentation, right=this PR. I've marked some areas with notable differences.
grafik

* fix wording and typos
* enable syntax highlighting
* enable line numbers for code blocks
* replace tabs in code blocks for unified layout
* upgrade skin (dependabot doesn't work for site.xml)
@laeubi
Copy link
Member

laeubi commented Dec 27, 2024

@Bananeweizen Should this backported to Tycho 4?

@laeubi laeubi enabled auto-merge (rebase) December 27, 2024 08:29
@Bananeweizen
Copy link
Contributor Author

@laeubi might be useful to be backported so it goes live on the website. I guess a real 5.0 release is still far away, right? but I'm also okay with not backporting, if that creates additional effort.

@laeubi laeubi merged commit ca21995 into eclipse-tycho:main Dec 27, 2024
13 of 14 checks passed
@laeubi laeubi added the backport-to-tycho-4.0.x Can be added to a PR to trigger an automatic backport of the change label Dec 27, 2024
@eclipse-tycho-bot
Copy link

💔 All backports failed

Status Branch Result
tycho-4.0.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

backport --pr 4544

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-tycho-4.0.x Can be added to a PR to trigger an automatic backport of the change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants