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

Update the current build to use the CSS. #2489

Open
billy-the-fish opened this issue Oct 18, 2022 · 0 comments
Open

Update the current build to use the CSS. #2489

billy-the-fish opened this issue Oct 18, 2022 · 0 comments
Assignees
Labels

Comments

@billy-the-fish
Copy link
Contributor

Business case - fastest solution to have the same output as the current release
Fix version -
Subject Matter Expert - Iain
Reviewer - Emily
Scope - All ditamaps in https://github.com/AgoraIO/agora_doc_source/tree/master/en-US/dita/RTC-NG. You need to:

  1. Make a branch from milestone-1-update-the-dita-build.
  2. In Oxygen, open /agora_doc_source/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap.
  3. Choose the Agora HTML5 transformation.
    Screenshot 2022-10-18 at 15 45 22
  4. Run the configuration and check the output works ok.
  5. Associate the stylesheet you have made for the build to this file:
    Screenshot 2022-10-18 at 15 31 05
    Mahoosive hint, use a relative filepath so everyone can do the same thing. If the image does not help, here are the docs: https://www.oxygenxml.com/doc/versions/25.0/ug-editor/topics/webhelp-customizing-with-css.html?hl=css%2Cfile.
  6. Save the project, build and check your changes.
  7. Make a PR to the milestone branch and ask Iain to validate.
  8. Soon as this works, do the same thing for all other ditamaps.
    Estimated -
    Acceptance criteria - HTML output has the same look and feel as the current API refs. File names do not change.
    Additional valuable information:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants