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

OTC CatchUp ## Summary is not needed twice #71

Open
KartikSoneji opened this issue Aug 7, 2022 · 3 comments · Fixed by #89
Open

OTC CatchUp ## Summary is not needed twice #71

KartikSoneji opened this issue Aug 7, 2022 · 3 comments · Fixed by #89
Labels
enhancement New feature or request

Comments

@KartikSoneji
Copy link
Member

Each individual summary page includes the heading twice.

Summary of CatchUp #90
image of catchup summary #90

@sreekaransrinath
Copy link
Contributor

That's probably not where the About section belongs as well.

I suggest condensing it into one information dialog

@KartikSoneji
Copy link
Member Author

Since the combined summary template is used to build both the combined and individual summaries, there are a few ways of fixing this:

  1. Use the ifdef::[] macro to only show the title while building the combined summary.
    combined-summary-template.adoc
ifdef::building-combined-summary[]
[#{catchup_display_number}]
=== link:/summary/{catchup_display_number}[OTC CatchUp #{catchup_display_number}]
endif::[]
  1. Use tagged regions to tag the content and only include the tagged region while building the individual summaries.
    combined-summary-template.adoc
# tag::title[]
[#{catchup_display_number}]
=== link:/summary/{catchup_display_number}[OTC CatchUp #{catchup_display_number}]
# end::title[]
  1. Remove the header from the combined summary template and add the header while generating the combined summary in the build process.
    (maybe also rename combined-summary-template.adoc to content.adoc since it's not just used to build the combined summary)

@KartikSoneji
Copy link
Member Author

KartikSoneji commented Oct 21, 2022

cc: @OurTechCommunity/core @sreekaransrinath

SaketThota added a commit to SaketThota/catchup that referenced this issue Oct 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants