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

Test, adjust and plan refinements to standalone Docs production #59

Open
8 tasks
wendellpiez opened this issue Aug 7, 2023 · 0 comments
Open
8 tasks
Labels
enhancement New feature or request

Comments

@wendellpiez
Copy link
Collaborator

wendellpiez commented Aug 7, 2023

User Story:

#57 made adjustments to links in production of documentation for Hugo.

This is a followup Issue, to stabilize the parallel standalone documentation production (which creates full pages with CSS, not only div elements for Hugo) and plan any further work.

Goals:

  • Test links in standalone docs production along with Hugo-targeting production
    • Run a link checker or functional equivalent (e.g a Schematron)
  • Make any adjustments necessary for both to work well
  • In view of priorities, make further Issues to plan further improvements to standalone/test docs production, testing/diagnostics, interfaces or anything

For example, the last item could include a plan for better CSS layering.

Dependencies:

None known.

This issue is a good one for someone who wishes to become more familiar with the documentation pipeline, especially available facilities for debugging it.

Acceptance Criteria

  • Both standalone and Hugo documentation production are checked and corrected for link integrity
  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
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

No branches or pull requests

1 participant