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: Remove Tutorial Content from Official Docs #4236

Open
6 tasks
salmad3 opened this issue Jul 3, 2024 · 0 comments
Open
6 tasks

UPDATE: Remove Tutorial Content from Official Docs #4236

salmad3 opened this issue Jul 3, 2024 · 0 comments
Labels
component:docs Documentation additions or improvements. type:refactor

Comments

@salmad3
Copy link
Member

salmad3 commented Jul 3, 2024

Context:

With the establishment of tutorials.ignite.com by the EcoDev team, the primary documentation site for Ignite (docs.ignite.com) is proposed to function as a CLI-specific reference hub. This site will provide always-up-to-date CLI reference, including a breakdown of CLI commands, modules, and various capabilities.

In contrast, the tutorials site is designed to offer practical, end-to-end guidance on using the CLI and other Ignite products. This includes steps for building and scaffolding chains, use case-specific instructions, and clear entry and exit points tailored to the user journey.

As a result, tutorial and guide-based content that aligns with the purpose of the tutorials site should be removed from the primary docs site and redirected to tutorials.ignite.com. Relevant tutorials that have not yet been migrated should be transferred.

Versioning and Doc Generation:

Determine if previous versions can remain in the docs or be archived.

The removed tutorials in the docs should be captured in the next minor release. The docs will continue to be version-specific.

Tutorials have generally required manual upgrading, such as updating examples within the existing tutorials. For some time, these updates have been left behind. We can consider automation and version testing.

Acceptance Criteria:

Content removal:

Remove the following tutorials. Then migrate or replace on tutorials.ignite.com, where appropriate

Chores:

  • Add redirect configuration in the Docusaurus config to redirect to tutorials.ignite.com. For redirects without a direct reference, generally redirect to tutorials.ignite.com.
  • Create a page to highlight the new tutorials site and provide a direct link.

Notes:

After content removal, various documents should be improved and repurposed. The docs site will also be refactored to reflect its CLI-specific nature.

There may also be a unified experience between docs.ignite.com and tutorials.ignite.com to better meet the needs of users and builders.

@salmad3 salmad3 added component:docs Documentation additions or improvements. type:refactor labels Jul 3, 2024
@salmad3 salmad3 mentioned this issue Jul 3, 2024
19 tasks
@salmad3 salmad3 changed the title Remove Tutorial Content from Official Docs UPDATE: Remove Tutorial Content from Official Docs Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation additions or improvements. type:refactor
Projects
Status: Todo
Development

No branches or pull requests

1 participant