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.

Sign up for GitHub

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

Jump to bottom

Update MicroSite (GH Pages) for 2.x #332

Closed
ascheman opened this issue Aug 13, 2024 · 0 comments
Closed

Update MicroSite (GH Pages) for 2.x #332

ascheman opened this issue Aug 13, 2024 · 0 comments
Assignees
@ascheman
Labels
documentation

Comments

@ascheman
Copy link
Member

As a user of the new modularized HSC I would like to see proper documentation on the GitHub pages site.

  • Fix errors and missing links (in particular xrefs).
  • Re-factor development pages
    • Start with the Intro
    • Add the ChangeLog.
    • Separate design decisions
    • Show publication of new releases
    • Explain document builds
  • Refer to live code where ever possible.
  • Drop kbd-Macro (replace by HSC).
  • Unify local publication build and GH pages generation.
  • Use development branch for all (external) page references.
  • Don't use numbering in Architecture sections.
@ascheman ascheman changed the title Update Site for 2.x Update MicroSite (GH Pages) for 2.x Aug 13, 2024
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Update documentation (due to modularization)
7017c8b 
- Fix missing code tags (from 312)
- Fix xrefs for the misc. target docs (site/html5/PDF)
- Update/refactor outdated external URLs
- Fix missing attributes
- Drop JCenter in favor of Maven Central (and JitPack (321)
- Partially align formatting of adoc according to good practices
- Use SVGs in favor of PNGs for PlantUML
- Fix some typos, grammar etc.
- Treat 429 response codes during external link checking as success (it only means there is some rate limiting in place)
- Make the page location in HTML reports a hyperlink
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Rewrite README(s)
7ad824e 
- Separate core and gradle plugin docs
- Generate docs for integration test directly from the project root
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Build GH Pages
fe3581b 
- Move complete build logic to a new script
- Integrate standalone arc42 docs
- Use HSC itself to check the site
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Extend Manuals
3e040d7 
- Add Gradle Plugin manual
- Fix links in manuals/READMEs
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Move Gradle example to Plugin README
43b0cac
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Align with Gradle plugin directory structure
4a5dbbb
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Perform integration test with READMEs
f535c5c
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Fix doc include to dropped class (cf. 309)
8233b42
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Distinguish Installation vs. Usage
56ed2af
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Move Gradle usage to resp. README
8103666
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Switch to Java 11 for nice Sets
8f39028
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Fix Java docs
274ddc8
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Show current files, env. etc on error
0805e3f
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Make HSC version adoc attribute unique
0b1bbee
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Drop some unused doc files
56496d8
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Fix cross references
b6bb00d
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Add a hint to not remove PDF download
df7e22f
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Do not number arc42 sections in jbake
94abbb0
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Include existing (live) code where possible
391854f
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Drop kbd-macro for HSC
d3bf974
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Add ChangeLog to MicroSite
b901699
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Collect design discussions in MicroSite development section
4e6eee7
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Make dev docs first class citizen of MicroSite
e0b4a29
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Drop outdated checking hint
65defd7
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Drop outdated arc42 fork reference
e7b83eb
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Add badges
92f92f3
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Fix misc. typos and small AsciiDoc errors
363cdf5
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Unify and describe documentation build
993ac16
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Fix and extend Gradle Plugin docs
aad6762
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Always build GH pages
30440b9
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Upload GH pages artifact and prepare to publish
0a17795
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Build HSC and use it to check GH pages
cca37a2
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Bump DTCW/DTC
7724b3d
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 Use "latest" DTC version
177ca2e
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 URL of competitor has vanished
81dee41
ascheman added a commit that referenced this issue Aug 15, 2024
@ascheman
#332 From now on we have to keep our docs clean!
e7fd396
@ascheman ascheman self-assigned this Aug 15, 2024
This was referenced Aug 20, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ascheman ascheman

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ascheman