infinum / eightshift-docs

A documentation website for Eightshift open source projects

Eightshift Docs

A documentation website for Eightshift open source projects.

Visit:

https://eightshift.com/.

To run docs locally:

1. Clone this repo
2. Navigate to website folder inside the repo
3. Run npm install
4. Run npm start

Deployment is done through GitHub Actions by pushing the code to the main branch.

Who do I talk to?

If you have any questions or problems, please open an issue on github and we will do our best to give you a timely answer.

Maintainers

Eightshift Docs is maintained and sponsored by Eightshift and Infinum.

License

Eightshift Docs ©2021 Eightshift and Infinum. It is free software, and may be redistributed under the terms specified in the LICENSE file.

eightshift-docs's Issues

Add custom fonts example

I'll add a docs page for adding custom fonts and generating @font-face properties with postCssFontMagician.

better explain difference between simple and compound blocks

[FEATURE] Add chapter about multisite

If you want to run WPCLI in mulitisite you need to specify the --url prop

Adding custom taxonomies

Add Rest Fields API Example

@gabriel-glo You did implementation of custom field in the rest api can you do this?

Lets say by Friday 07.02.2020?

better explain how you can use manifest to share icons and other stuff across PHP and JS files

Put manifest examples from getActions Helper to manifest

It would be better if some details about object-specific things in manifest were in manifest documentation, instead of getActions helper part. The helper part suggests that it's kinda unimportant.

better explain why naming is hard and what you should think when naming component

Adding Custom Post Type

@kmaric69 You did implementation of custom post type, can you do this?

By Friday 07.02.2020

Should the issues from the frontend libs and libs be transferred here?

There are lots of issues in both libs

https://github.com/infinum/eightshift-libs/issues
https://github.com/infinum/eightshift-frontend-libs/issues

Should all of these be transferred here?

@infinum/eightshift-team

[FEATURE] Add chapter on reusable blocks

They are super useful, especially when you need to have a partial that will be shown on all the pages (footer partial etc.).

We should explain:

• What reusable blocks are
• How to register the menu that will display them
• Example of usage (partials)

[FEATURE] Add a boilerplate 4 -> 5 mirgation guide

We were discussing in the slack how to migrate from old to a new version and maybe that could be added as a chapter in the docs, not overly detailed, just some basic steps (list of things to do).

Could be useful if we want to move older projects to new ones, but also if anybody using the older version would like to upgrade.

explain the issue with component names

infinum/eightshift-frontend-libs#222

New folder structure

Main nav:

• Get Started
• Docs
• Storybook

Get Started nav:

• Theme
• Plugin

Docs Nav:

• The Basic
  -- Libs
  -- Frontend Libs
• Guids
  -- ...
• Advance
  -- ....

Update advance part of the docs

Add subchapter on adding another entrypoint for Webpack

Adding a separate CSS or JS build for functionalities that may not be a part of WP theme.

[BUG] Search seems to be broken

No matter what I search for, it looks broken and returns page not found 🤷🏼‍♂️

Screen.Recording.2021-01-25.at.14.41.19.mov

Add General docs

https://infinum.github.io/eightshift-docs/docs/guides/general

https://github.com/infinum/eightshift-libs/tree/develop/src/general

Add automatic deployment

We need to add automatic deployment when a new commit is detected in master:

https://docusaurus.io/docs/en/publishing#using-travis-ci

Add Columns docs

https://infinum.github.io/eightshift-docs/docs/guides/columns

[FEATURE] Explain how to use props helper to limit attributes passed in the component

Fix Post type docs

https://infinum.github.io/eightshift-docs/docs/guides/post-type

to match the other docs

List of code examples

A working list of examples we should write at some point. If you're working on one you should open a new issue and assign it to yourself.

Also feel free to add example ideas here:

• Register custom post type
• Register custom taxonomy
• Use custom fonts
• Copy existing block / component
• Add new block / component
• Disable core blocks (only allow our custom blocks)
• Use of DI container (libs)

[FEATURE] Update to latest version

We should update the docusaurus and all the libs to the latest version to see if there are any improvements.

Note: last time this was attempted, there were some breaking issues with webpack.

Split the docs for libs and frontend libs

Currently, we don't have any documentation on what frontend libs helpers we have on the JS side. For scss we have the generated docs, but nothing on things like responsiveSelectors and how to use them.

explain webpack dynamic import

Add With Select details

Explain how to use withSelect

import { withSelect } from '@wordpress/data';

const ImageInfiniteEditorWithSelect = (props) => {
  const {
    attributes: {
      blockClass,
      media,
    },
  } = props;

  return (
    <div className={blockClass}>
      {
        media.map((item) => {
          return (<ImageEditor
            blockClass={blockClass}
            url={item}
          />)
        })
      }
    </div>
  );
};


export const ImageInfiniteEditor = withSelect( (select, props) => {
  const {
    attributes: {
      media,
    },
  } = props;

  const images = media.map((item) => {
    const image = wp.data.select('core').getMedia(item);

    if (typeof image !== 'undefined') {
      return image.source_url;
    }
  });

  return {
    attributes: {
      media: images,
    },
  }

})(ImageInfiniteEditorWithSelect);

[FEATURE] Explain what is responsiveAttributes used for

Add enqueue docs

https://infinum.github.io/eightshift-docs/docs/guides/enqueue

better explain difference between component and block for naming attributes and helpers

[FEATURE] Explain how to override options to show from the parent component

Add Rest Route API Example

Add rest route example

Add example of object prop type check

We should document how and why to do the checks when dealing with object prop types.

For example

export const SomeExampleComponentEditor = ({ attributes, actions }) => {
  const {
    paragraph,
    verticalAlign,
  } = attributes;

  const paragraphObject = (typeof paragraph === 'undefined') || paragraph;

  // use it in the component safely.
  ...
}

Add Blog feature to Docs site

We need a couple of quick tutorial articles on how to do some specific things on Eightshift Boilerplate.

First we need to investigate how to enable this feature on Docusaurus and how it works

Change Link title in sidebar for index pages

It would be better to change the title of the index page inside the sidebar to Introduction.

we can do that with just adding sidebar_label: Introduction to every index page

Add some styling to the homepage

[FEATURE] New graphics for the Eightshift universe repos

As discussed, this issue covers creating new graphics to represent Eightshift in repos and on social networks.

This is the current illustration:

We need these:

• Eightshift libs
• Eightshift frontend libs
• Eightshift boilerplate
• Eightshift boilerplate plugin
• Eightshift docs
• Eightshift forms
• Eightshift starter task?

[FEATURE] how to set attributes based on the post type usage

Malformed JSON in the example (trailing comma)

The Media Attribute manifest.json example in get actions helper docs page has a trailing comma:

{
  "attributes": {
    "media": {
      "type": "object",
      "default": {
        "id": 0,
        "url": "",
        "title": ""
      },
      "items": {
        "type": "object"
      },
      "mediaAction": true
    }, <---- !
  }
}

better explain why you should add all additional option to the component

Proofreading everything

better explain what your mindset should be when creating components

Docs styling updates

I'll try to do some styling changes to make existing layout look more usable.
Also I'll play around with the general color pallet of the docs site.

better explain how use defaults from a component in an manual way for example featured-posts block

[FEATURE] Add VSC code snippets

Edit SassDoc styles

Try to make SassDocs's style a little more in line with rest of docs.

[FEATURE] Explain how to use css variables and how to set it up

Add search option

Add custom badged to docs

Add custom badges that link a doc page to specific libs repository and/or source code.

Example of the custom badge for eightshift-libs:

[![docs-source](https://img.shields.io/badge/source-eigthshift--libs-blue?style=for-the-badge&logo=php&labelColor=2a2a2a)](https://github.com/infinum/eightshift-libs)

Example of the custom badge for eightshift-frontend-libs:

[![docs-source](https://img.shields.io/badge/source-eigthshift--frontend--libs-yellow?style=for-the-badge&logo=javascript&labelColor=2a2a2a)](https://github.com/infinum/eightshift-frontend-libs)

[FEATURE] Better explain props helper

• why to never use $componentName
• casing (kebab-camel case)
• limit on renaming components with the component that all-ready exist.