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

Remove distinction between docs and blog #8885

Closed
1 of 2 tasks
dionjwa opened this issue Apr 12, 2023 · 2 comments
Closed
1 of 2 tasks

Remove distinction between docs and blog #8885

dionjwa opened this issue Apr 12, 2023 · 2 comments
Labels
closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) proposal This issue is a proposal, usually non-trivial change

Comments

@dionjwa
Copy link

dionjwa commented Apr 12, 2023

Have you read the Contributing Guidelines on issues?

Motivation

I want blog features in docs, and docs feature in blogs, and I encounter many issues where others want similar things, and the distinction between them is unclear.

  • they both show "pages"
  • authors can be shown in blog posts, and it's desired to show them in docs
  • desired similar controls for sidebars, navigation, etc, but some things like disabling the right navigation, is possible in docs, but not blogs

You get the idea. These could be the same thing, just configured slightly differently

Self-service

  • I'd be willing to do some initial work on this proposal myself.
@dionjwa dionjwa added proposal This issue is a proposal, usually non-trivial change status: needs triage This issue has not been triaged by maintainers labels Apr 12, 2023
@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Apr 12, 2023

These things should be proposed one-by-one: saying "they should support the same things" isn't very actionable, because they are distinct sets of features with different goals of UX and content management. For example, the primary organization of docs would always by sidebar, while for blog it's always in linear chronology. We don't expect this fundamental concept to change.

they both show "pages"

Not sure what this means

authors can be shown in blog posts, and it's desired to show them in docs

Showing authors for docs is proposed in #6218. It's more complex than blog, because docs are constantly updated and re-written, so there does not exist one clear "author" of a page, and we can only display a list of contributors.

some things like disabling the right navigation, is possible in docs, but not blogs

The hide_table_of_contents front matter key is supported by both docs and blog: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog#hide_table_of_contents

Are there others you'd like to propose? Otherwise I will close this as unactionable.

@slorber
Copy link
Collaborator

slorber commented Apr 13, 2023

There is a distinction between docs and blogs because those are different plugins run by different codes that are decoupled.

The best we can do is to try to make the API and behavior of both plugins consistent with each others so that they are more intuitive to use.

If you notice a consistency problem that we should aim to fix to improve the DX, please open a dedicated issue per subject so that we can discuss each subject independently, instead of creating one issue for everything.

@slorber slorber closed this as not planned Won't fix, can't repro, duplicate, stale Apr 13, 2023
@slorber slorber added closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) status: needs triage This issue has not been triaged by maintainers and removed status: needs triage This issue has not been triaged by maintainers labels Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Development

No branches or pull requests

3 participants