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.

Sign up for GitHub

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

Jump to bottom

[project] Glues - Doc files from glue repo #145

Open
11 tasks
dalssoft opened this issue Aug 7, 2022 · 1 comment
Open
11 tasks

[project] Glues - Doc files from glue repo #145

dalssoft opened this issue Aug 7, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@dalssoft
Copy link
Member

dalssoft commented Aug 7, 2022 •
edited by jhomarolo
Loading

Since the technical feasibility of having the documentation of each glue in its own repository has been demonstrated (issue: #111 / PR: #143) , we need a project to move the documentation to the appropriate repositories, following a pre-defined standards.

For each glue repo we must:

  • check if herbsjs.github.io or the original repo has the most updated doc
  • create a folder ./doc/herbsjs.org/ on each glue repo with the doc files to be used (ex: .md files).
  • replace the current README.md doc with a simple link to the corresponing doc on herbsjs.org in order to avoid having multiples source of information.

This issue will keep track of the issues and PRs among this repo (herbsjs.org) and glues' repos.

Repos to move:

  • Herbs Shelf - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • GraphQL - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • REST - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • Knex - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • Mongo - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • REPL - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • Error to Text - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
  • Code Snippets - herbsjs.org: (issue: __ / PR: __ ) / glue repo: (issue: __ / PR: __ )
@dalssoft dalssoft added the enhancement New feature or request label Aug 7, 2022
@dalssoft dalssoft mentioned this issue Aug 7, 2022
Open
@jhomarolo
Copy link
Contributor

@judibo can you take this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
Herbs enterprise roadmap 2023
Status: Ready to code
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dalssoft @jhomarolo @italojs