Skip to content

Link to new VC Community Docs site #1339

@meg-gutshall

Description

@meg-gutshall

Is there an existing issue for this?

  • I have searched the existing issues

Type of Change

Edit/Clarification on existing content

URL of existing page

https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/coffee-table-groups

Context for content change

This page is supposed to be a duplicate of this page, however, we have to manually update both pages each time a change is made to a Coffee Table Group.

Furthermore, many of these guides to Virtual Coffee are already fully fleshed out in the VC Community Docs repo. It doesn't make sense to have two copies that are constantly out of sync when we've implemented Docusaurus.

Proposed solution

Simple Fix Solution

Since @adiati98 has put in all that amazing work of getting the VC Community Docs site online, I think we should start linking to it heavily from our vc.io site.

Pros

  • Much of the content in the vc.io website is already documented in the VC Community Docs site, so we'll instantly gain a value boost
  • In regard to updates going forward, there will be an immediate reduction of labor while providing the equivalent or enhanced content outcomes
  • Retains an organized structure and allows for increased discoverability

Cons

  • Navigating between vc.io and the VC Community Docs site isn't intuitive nor user-friendly as they are very much still separate entities
  • There will be a lift at the very beginning to ensure no information is lost in the deduping process

The More Involved One

We can create MDX partials and dynamically import sections or even whole pages into each site from a central location. This would require vc.io and the VC Community Docs to co-exist within a monorepo folder structure.

Pros

  • The monorepo architecture is something we can take care of as Maintainers/Documentation Lead and need not concern our open-source contributors
  • There will be one definitive place to update content that would otherwise be duplicated across both the vc.io website and the VC Community Docs site

Cons

  • The monorepo folder structure will take some configuring behind the scenes
  • Save any fancy git-fu, there would be yet one more repo to keep track of

Resources that can help

No response

Collaborators

@adiati98 @danieltott @BekahHW

Code of Conduct

  • I've read the Code of Conduct and understand my responsibilities as a member of the Virtual Coffee community

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: DiscussionThis item is not yet ready for developmentType: ContentContent additions or updates

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions