Skip to content

Conversation

derrickmehaffy
Copy link
Member

@derrickmehaffy derrickmehaffy commented Dec 7, 2020

This PR is a work in progress and should not be merged before:

What has been done:

  • Moved Developer Docs to new latest version system
  • Added SEO Plugin, pending refactoring to add meta tags to existing docs
  • Modified the Header Nav to make it easier to link documentation and ecosystem resources
  • Adjusted Vuepress Width to 900px to prevent horizontal scrolling on certain pages/tables

Notes:

  • Each documentation now runs on it's own port while in development mode
    • Developer is on port 8081
    • User is on port 8080

@derrickmehaffy derrickmehaffy added flag: don't merge This PR should not be merged at the moment source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide pr: updated content PRs updating existing documentation content labels Dec 7, 2020
@derrickmehaffy derrickmehaffy changed the base branch from main to content-manager December 14, 2020 21:08
@derrickmehaffy derrickmehaffy merged commit e659d1d into content-manager Dec 14, 2020
@derrickmehaffy derrickmehaffy deleted the docs/config branch December 14, 2020 21:19
derrickmehaffy added a commit that referenced this pull request Dec 14, 2020
* Write introduction for user guide

* Create file + write documentation about accessing admin panel

* Create file for documentation about setting up profile

* Update TOC with new file + Try user guide structure

* Create files for Content Manager documentation

* Update TOC with Content Manager documentation files

* Write 'Introduction to the Content Manager' documentation

* Update TOC

* Add screenshots for Content Manager introduction

* Improve Content Manager introduction + Add screenshots

* Improve content for Content Manager Introduction

* More content improvements on the Content Manager Introduction

* Start working on the fields table for Writing Content

* Incorporate Relational Fields elements in Content Manager introduction

* Write 'Writing content' documentation

* Update TOC

* Delete 'Deleting content' file + Update TOC

* Write documentation for 'Saving, publishing and deleting' content + Add screenshots

* Reuse content from Introduction for 'Configuring view' documentation + Improve both

* Write introduction for user guide

* Create file + write documentation about accessing admin panel

* Create file for documentation about setting up profile

* Update TOC with new file + Try user guide structure

* Write introduction for user guide

* Create file + write documentation about accessing admin panel

* Create file for documentation about setting up profile

* Update TOC with new file + Try user guide structure

* Create files for Content Manager documentation

* Update TOC with Content Manager documentation files

* Write 'Introduction to the Content Manager' documentation

* Update TOC

* Add screenshots for Content Manager introduction

* Improve Content Manager introduction + Add screenshots

* Improve content for Content Manager Introduction

* More content improvements on the Content Manager Introduction

* Start working on the fields table for Writing Content

* Incorporate Relational Fields elements in Content Manager introduction

* Write 'Writing content' documentation

* Update TOC

* Delete 'Deleting content' file + Update TOC

* Write documentation for 'Saving, publishing and deleting' content + Add screenshots

* Reuse content from Introduction for 'Configuring view' documentation + Improve both

* Add icons + Improve content

* Add note about components and dynamic zones in Writing Content

* Complete and improve User Guide Introduction

* Improve Accessing Admin Panel + Add screenshot

* Write User Profile documentation + Add screenshot

* Restructure all files + Replace bad screenshot

* Remove emojis from main TOC

* Proofread + Improve

* Proofread + Improve + Add new screenshots

* Improve after reviews

* Improve again after more reviews

* Improve after reviews

* Rework the components part of Writing content

* More improvements after more reviews

* Improve + Fix errors after Product team reviews

* Create relational fields management documentation + Add screenshots

* Improve relational fields doc after proofread

* Fix typos

* Improve relational fields doc

* Improve relational fields doc after review + Improve wording

* Fix wording issues

* Fix wording issues

* Introductions to empty User Guide sections (#11)

* Write Content-Types Builder introduction + Add screenshot + Update TOC

* Improve Content Types Builder introduction

* Write introduction for users, permissions and roles

* Start writing introduction for plugins section

* Update TOC + Delete settings section

* Finish writing introductions + Add work in progress message

* Fix typo + Add screenshots for plugins + users and permissions introductions

* Updating Vuepress Configs, new header nav, and SEO Plugin (#10)

* WIP Restructuring docs and header nav / adding SEO plugin

* Merge CTM menu

* how about actually adding files lol

* Adjusting configs and updating doc links

Co-authored-by: Derrick Mehaffy <derrickmehaffy@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag: don't merge This PR should not be merged at the moment pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant