Go live task list

[mojavelinux]

This issue tracks the remaining tasks to complete to make the new docs site go live. It's only meant to communicate progress and provide a picture of what tasks remain.

• reconfigure symbolic name for latest version (Define symbolic name for the most up to date version of a component: "current" or "latest" #26)
• add copy to clipboard button to source blocks (UI) (Add a copy to clipboard button to source blocks asciidoctor-docs-ui#13)
• consolidate explore panel (UI) (Hide version list in explore panel for versionless components asciidoctor-docs-ui#18)
• allow playbook to control order of components in explore panel (UI) (Allow components in explore panel to be rearranged asciidoctor-docs-ui#16)
• finalize and merge new topbar (which provides quicklinks to navigate the site) (UI) (Use the topnav as quicklinks to the projects included in the documentation site asciidoctor-docs-ui#11)
• reconfigure breadcrumbs to use navtitle for component versions start page (UI) (Use navtitle in breadcrumbs for discrete (aka orphaned) page asciidoctor-docs-ui#22)
• fix word wrap behavior in tables (apply CSS from Asciidoctor default stylesheet) (UI) (Fix word wrap setting asciidoctor-docs-ui#27)
• expand nav eagerly (either using embedded script or from template) (Fix word wrap setting asciidoctor-docs-ui#27)
• only add slot for sidebar TOC if template detects section in page.content (Don't add slot for toc sidebar if page has no sections asciidoctor-docs-ui#32)
• add admonition icons to UI / use icons for menu separator and checklist boxes (UI) (resolves #25 integrate Font Awesome 5 using SVG with JS; add icons to admonition blocks asciidoctor-docs-ui#26)
• add LICENSE file to this repository
• send PR to asciidoctor repo with asciidoctor component (resolves #3861 import Asciidoctor docs asciidoctor#3880)
  • merge docs for asciidoctor component into Asciidoctor repository
  • update playbook with new content source and merge PR (Update content source for Asciidoctor docs in playbook #34)
• set up component in asciidoctor-community-docs for home page (folder: home); move existing docs in that repository into docs folder
• rewrite intro page for site and configure as site start page
• fix table of built-in attributes (most basic fix possible) (Consolidate Header Set and Body Set columns in document attribute reference to Header Only asciidoc-docs#24)
• move intrinsic attributes table to document attributes page (Fold intrinsic attribute reference into document attribute reference asciidoc-docs#26)
• set up CHANGELOG file for asciidoc-docs repo (Set up CHANGELOG file asciidoc-docs#28)
• remove migration in progress notice on asciidoc-docs repo
• enable checklinks plugin in deploy preview
• fix broken deep links
• add asciidoctor-reveal.js (reveal.js-converter) to docs site (add Asciidoctor reveal.js documentation #24)
  • change source branch to 4.1 (use Asciidoctor reveal.js maintenance branch for 4.1 docs #36)
• add asciidoctor-maven-plugin (maven-tools) to docs site
• add asciidoclet to docs site (Add Asciidoclet docs #25)
  • add asciidoclet to search config (resolves #40 add asciidoclet component to search config #41)
• add asciidoctorj to docs site (must happen at the same time site is going live)
  • update references to asciidoctorj in asciidoctor core to use index page xref instead of URL to repo (update AsciidoctorJ URLs to xrefs and page ID asciidoctor#3888)
  • add ascidoctorj to search config
• configure Netlify site to use docs.asciidoctor.org (Switch to docs.asciidoctor.org domain #14)
  • request TLS cert for docs.asciidoctor.org
• add Algolia logo to footer (UI) (update logos in footer asciidoctor-docs-ui#24)
• enable search for all components (Enable search on Asciidoctor.js, Asciidoctor reveal.js and Maven tools components #30)
• add optional "in this project" filter to search (Add project (aka component) filter to search asciidoctor-docs-ui#37)
• trigger search automatically or on a schedule (Setup DocSearch #7)

[mojavelinux]

We may consider getting the docs running on docs.asciidoctor.org before we start redirecting from asciidoctor.org. This soft launch period will allow us to exercise the site, discover issues, and fix them before making an official public announcement.

[ggrossetie]

add Algolia logo to footer

Is it mandatory? There is already a "Search by" mention at the bottom of the search result:

fix table of built-in attributes (most basic fix possible) (asciidoc)

Can I help? What needs to be done?

enable search for all components

Should I configure something on Asciidoctor.js or Asciidoctor reveal.js?

[mojavelinux]

Is it mandatory (to add an Algolia icon to the footer)

I think it's only fair. They have granted us an OSS plan. And it does as much for the site as Netlify. Plus, we have a space for it.

[mojavelinux]

What needs to be done? (for fix table of built-in attributes).

See asciidoctor/asciidoc-docs#1

[mojavelinux]

Should I configure something on Asciidoctor.js or Asciidoctor reveal.js? (for search)

The search is configured here: https://github.com/asciidoctor/docs.asciidoctor.org/blob/main/docsearch/config.json I would like to see the versions managed automatically from the site build, but if we have to start with manual updates, it's okay.

[mojavelinux]

I think we should move the rollout of the redirects to a separate issue since we'll enable it after docs.asciidoctor.org is resolving.

[graphitefriction]

@mojavelinux which repository do you want the redirects-rollout checklist/issue to be filed in?

[mojavelinux]

The redirects, which we won't put in place until hard launch, are now being tracked here: asciidoctor/asciidoctor.org#981

[graphitefriction]

The PR changing {url-asciidoctorj} to xref:asciidoctorj::index.adoc is ready: asciidoctor/asciidoctor#3888

[mojavelinux]

And with that, we're soft launched! 🚀

We'll address the official launch and announcement in separate issues.