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

Distinguish Between Piral Dev and Piral Instance Dev #42

Closed
3 tasks done
FlorianRappl opened this issue Jul 30, 2019 · 1 comment
Closed
3 tasks done

Distinguish Between Piral Dev and Piral Instance Dev #42

FlorianRappl opened this issue Jul 30, 2019 · 1 comment
Labels
bug Something isn't working documentation Concerns the available documentation.
Milestone

Comments

@FlorianRappl
Copy link
Contributor

Prerequisites

  • Can you reproduce the problem in a MWE?
  • Are you running the latest version?
  • Did you perform a search in the issues?

Environment Details and Version

Using https://docs.piral.io.

Description

The general documentation includes a "Development" section, which, unfortunately, has nothing to do with the expected "development of a Piral instance", but rather with the "development of Piral itself".

We need to introduce some terminology to make clear what is what.

Steps to Reproduce

  1. Open docs.piral.io
  2. Go to the first tile - documentation
  3. See "Development" noted in the sidebar / close to the bottom

Expected behavior

The development of Piral itself should maybe be constraint to the GitHub repository, e.g., the README files.

The following strategy could help:

  • The main README.md (root): informs about repo structure, important pages, services, ... - very quick intro
  • The README.md of "src" includes the development guide for Piral; referring also to the sub-README files
  • The README.md of "src/packages" lists these packages, their intentions, and whats necessary for their development + vision
  • The README.md of "src/pages" again, explains these repositories, their intentions, and vision
  • Same for README.md of "src/demos"
  • The README.md of specific packages (e.g., piral-vue) has documentation as accessible as possible for people coming to NPM

Actual behavior

Right now it is quite a mix. Not very user friendly.

Possible Origin / Solution

The documentation is growing and the organization needs to be more strict.

cc @lschoett @iotcloudarchitect

@FlorianRappl FlorianRappl added bug Something isn't working documentation Concerns the available documentation. labels Jul 30, 2019
@FlorianRappl FlorianRappl added this to the 0.6.2 milestone Jul 31, 2019
@FlorianRappl
Copy link
Contributor Author

Landed in devel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Concerns the available documentation.
Projects
None yet
Development

No branches or pull requests

1 participant