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

CAMEL-16639: lowercase AsciiDoc attributes and related changes #6124

Merged
merged 2 commits into from
Sep 21, 2021

Conversation

djencks
Copy link
Contributor

@djencks djencks commented Sep 21, 2021

In this PR (not completely in commit order) (some squashing could be appropriate if we agree on all these changes, but the added comments might be useful for future understanding):
Tooling:
95e3200

  • generate headers with lowercase attribute names doctitle, attributeid, shortname, and supportlevel. AsciiDoc attribute names are case insensitive and lowercase by default: doctitle is very standard and we shouldn't argue with it.
  • Use lowercase doctitle in gulpfile.js
  • (Important!) Fix detection of EIP docs so that they are recognized and updated by UpdateReadmeMojo during the main build. The previous code was extremely incorrect and only worked when maven is run in the core/camel-core-engine directory.
    86220d0, 1945dea
  • Comment out and remove code that seems to have no purpose other than preventing camel-disruptor-vm-component.adoc from being processed.
    9057c88
  • Remove some useless code that updates parts of the component model that aren't used.
    e808961
  • Stop adding the useless [[link-name]] to the top of every file. There might be some circumstance in which this header would be useful, but it is ignored in Antora. I verified that removing these makes no change in the generated site.

Manual changes:
0469b9f

  • Remove reactive-threadpoolfactory-vertx.adoc from docs since the source was renamed to threadpoolfactory-vertx.adoc in commit bac083b on 31 July 2020
    af64bcb
  • Fix doctitle in options partials
    7bef09f
  • Fix doctitle in summary docs
    455746f
  • Manually update core/camel-main/.../main.adoc including a TODO. Some 'others' pages seem to have corresponding .json files, perhaps we should use them to generate option tables? main.adoc has other problems as well.
    a672559
  • Update and add DSL group to dsl/.../kamelet-main.adoc. If this page should not be in the DSL group, someone needs to add a comment explaining why, and why it's in the dsl directory but not the DSL group.
    d1ee6fb
  • Manually update other dsl adocs (they aren't automatically updated). Also make the doctitle and shortname reasonably consistent. Also concatenate duplicate supportlevel attributes. Several of these dsl pages were not previously in nav, perhaps this can be reviewed by someone who knows about the actual state of DSL support.
    bbf1cf6
  • Manually update properties-component.adoc (no corresponding json file)
    44acb3f
  • Expected changes to others nav as a result of previous changes

Generated changes: cb3d52b

and finally
067bf58

  • Remove bogus [[link name]] first lines. Some of this would be generated from e808961, but by no means all. Regenerating the docs after this change results in no additional changes.

Copy link
Member

@zregvart zregvart left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up!

Tooling changes in UpdateReadmeMojo and gulpfile.js

Remove bogus code that has no effect on the results of this mojo, other than preventing it from acting on camel-disruptor-vm-component.adoc

Remove useless code from UpdateReadmeMojo that modifies unused parts of the component model

Don't add bogus [[]] pre content

fix doctitle in options partials
Remove reactive-threadpoolfactory-vertx.adoc from docs since the source was renamed to threadpoolfactory-vertx.adoc in commit bac083b on 31 July 2020

Fix doctitle in summary docs

Manually update core/camel-main/.../main.adoc including a TODO

Update and add DSL group to dsl/.../kamelet-main.adoc

Manually update other dsl adocs

Manually update properties-component.adoc

Generated changes

Remove bogus [[link-name]] pre content from non-generated files
@djencks djencks merged commit 453d621 into apache:main Sep 21, 2021
@djencks djencks deleted the main-lowercase-attributes branch September 21, 2021 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants