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

Merge both Developer and User docs into a single vuepress instance #115

Merged
merged 58 commits into from Feb 18, 2021

Conversation

derrickmehaffy
Copy link
Member

What does it do?

Combines both dev and user docs into a single vuepress

Why is it needed?

  • Fix search issues
  • Easier documentation management
  • my own sanity

Related issue(s)/PR(s)

Possibly fixes #40

@derrickmehaffy derrickmehaffy added source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo pr: updated content PRs updating existing documentation content labels Feb 10, 2021
@derrickmehaffy derrickmehaffy added the flag: 💥 Breaking change This PR contains breaking changes and should not be merged label Feb 10, 2021
@derrickmehaffy
Copy link
Member Author

Something we should look at to cut down on the deployment work required with @alexandrebodin and nginx redirects is: https://vuepress-community.netlify.app/en/plugins/redirect/#installation

@derrickmehaffy derrickmehaffy marked this pull request as ready for review February 10, 2021 16:02
@pwizla
Copy link
Collaborator

pwizla commented Feb 10, 2021

Thanks for the work @derrickmehaffy

I quickly checked and sadly it does not seem that this PR fixes #40
We can still merge it, will eventually try to have a deeper look at this specific issue.

@alexandrebodin
Copy link
Member

@pwizla how did you test the #40 ? as the algolia search is only generated from the live website note sure you can verify it locally :)

Since this unique "tutorial" doesn't seem to exist anymore, and since the
"Concepts" section is not directly accessible from the sidebar,
I modified the sentence and linked to our page for tutorials.
Previously, the broken link in `custom-admin.md` was pointing to a
"Customization" concept that included two things:
* Plugin extensions
* and Admin extensions

Since the link is actually referring to both "concepts" that are now
split apart, I chose to:
* link from the guide to admin panel customization
* and then add a link in this admin panel customization section to
  the Strapi plugins section, so you have all the required information
Just like in commit 2f8e748, referring to the "customization concept"
does not make any sense anymore here. Indeed, this previously existing
concept covered 2 topics: plugin extensions and admin panel extensions.
Each of them has been moved to the appropriate location. So I'm
adapting the text just to make sure we link to the related part of the
concept, i.e "plugin extensions".
@pwizla pwizla merged commit 730a3c9 into docs_restructuring Feb 18, 2021
@pwizla pwizla deleted the repo/singleVuepress branch February 18, 2021 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag: 💥 Breaking change This PR contains breaking changes and should not be merged pr: updated content PRs updating existing documentation content source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants