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

Jump to bottom

fold mochajs.github.io into this repo #2987

Closed
boneskull opened this issue Sep 5, 2017 · 5 comments
Closed

fold mochajs.github.io into this repo #2987

boneskull opened this issue Sep 5, 2017 · 5 comments
Assignees
@boneskull
Labels
area: documentation anything involving docs or mochajs.org area: repository tooling concerning ease of contribution

Comments

@boneskull
Copy link
Member

GH Pages now supports docs/ since whenever.

I propose we fold that repo into this one, because:

  1. Discoverability is an issue if the docs live in a separate repo.
  2. The alternative is a gh-pages branch, but it's plainly silly to maintain a branch with a completely separate VCS root.

Potential drawbacks:

  1. Tooling on that repo is kind of iffy.
  2. May need to manually move some issues over.

What does @mochajs/core think?
@boneskull boneskull added area: repository tooling concerning ease of contribution area: documentation anything involving docs or mochajs.org labels Sep 5, 2017
@boneskull boneskull self-assigned this Sep 5, 2017
@dasilvacontin
Copy link
Contributor

LGTM. I like that PRs can update the docs at the same time.

@ScottFreeCode
Copy link
Contributor

The pros definitely outweigh the potential cons here.

Only one minor thing to consider, re. concern # 1: If the site currently requires additional tooling of some sort instead of just updating Markdown and/or HTML files, we may want to figure out how to cut that out first in the existing repo and then copy the page source files over into this one, so we don't have to add anything here but the page source files.

But I think ultimately, as long as we aren't adding anything to the package.json of the main project (e.g. if any needed tooling can go inside docs), it's not a dealbreaker either way.

@boneskull
Copy link
Member Author

it wouldn't add any production deps anyhow. would prefer to keep the dev deps all together so a contributor doesn't need to npm install from docs/. agree?

@dasilvacontin
Copy link
Contributor

dasilvacontin commented Sep 5, 2017 via email

@ScottFreeCode
Copy link
Contributor

Hmm. I was thinking of avoiding adding to our already lengthy dev install times e.g. in CI, but simplicity for contributors is a compelling argument. Well, in that case, I'm fine bringing it over here as-is to start with and we can look at any potential for trimming dependencies later.

@ScottFreeCode ScottFreeCode mentioned this issue Oct 3, 2017
Closed
1 task
@ScottFreeCode ScottFreeCode mentioned this issue Nov 15, 2017
Closed
boneskull added a commit that referenced this issue Dec 6, 2017
@boneskull
migrate gh-pages site into docs/; closes #2987
817a0fc 
- some jekyll tweaks were needed; we can no longer consume the
  `github-pages` gem apparently since they added support for themes
- added `markdown-toc` dev dep to build the toc
- added `buildDocs` and `serveDocs` scripts
- miraculously avoided monkeying with the content itself

Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
boneskull added a commit that referenced this issue Dec 6, 2017
@boneskull
migrate gh-pages site into docs/; closes #2987 [ci skip]
43194b6 
- some jekyll tweaks were needed; we can no longer consume the
  `github-pages` gem apparently since they added support for themes
- added `markdown-toc` dev dep to build the toc
- added `buildDocs` and `serveDocs` scripts
- miraculously avoided monkeying with the content itself

Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
boneskull added a commit that referenced this issue Dec 9, 2017
@boneskull
merge mochajs.github.io into mocha under docs/; closes #2987
f24607e 
Merge branch 'issue/2987-docs'

* issue/2987-docs: (272 commits)
  update node/npm requirements [ci skip]
  Mocha Sidebar: capitalization tweaks + remove huge gif [ci skip]
  Mocha Sidebar: fix wording [ci skip]
  add mocha side bar as extension for vs code [ci skip]
  update parameter order of example assert [ci skip]
  Improve description of --check-leaks option [ci skip]
  Update 'Arrow Function' wording for clarity. [ci skip]
  fix Gemfile [ci skip]
  migrate mochajs.github.io into mocha; closes #2987 [ci skip]
  move everything into docs/ in prep for moving repo into mocha proper
  Fix hyperlink for async_hooks
  add section on --exit / --no-exit
  update "Usage" and "--compilers" sections
  Fix typo in "Using async / await" snippet
  Update index.md
  Add `--inspect`
  **Bug** Edge renders the icon for a backer without an image to take up the entire screen.
  drop shx dependency
  chore(package): update shx to version 0.2.0
  fix hardcoded scheme in anchor.js url
  ...

# Conflicts:
#	.gitignore
@dependencies dependencies bot mentioned this issue Dec 29, 2017
Merged
@renovate renovate bot mentioned this issue Feb 14, 2018
Merged
OmgImAlexis pushed a commit to agenda/agenda that referenced this issue Jun 26, 2018
@renovate @OmgImAlexis
Update dependency mocha to v4.1.0 (#634)
f0d0615 
This Pull Request updates dependency [mocha](https://github.com/mochajs/mocha) from `v4.0.1` to `v4.1.0`



<details>
<summary>Release Notes</summary>

### [`v4.1.0`](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#&#8203;410--2017-12-28)
[Compare Source](mochajs/mocha@v4.0.1...v4.1.0)
This is mainly a "housekeeping" release.

Welcome [@&#8203;Bamieh] and [@&#8203;xxczaki] to the team!
#### 🐛 Fixes

- [#&#8203;2661]: `progress` reporter now accepts reporter options ([@&#8203;canoztokmak])
- [#&#8203;3142]: `xit` in `bdd` interface now properly returns its `Test` object ([@&#8203;Bamieh])
- [#&#8203;3075]: Diffs now computed eagerly to avoid misinformation when reported ([@&#8203;abrady0])
- [#&#8203;2745]: `--help` will now help you even if you have a `mocha.opts` ([@&#8203;Zarel])
#### 🎉 Enhancements

- [#&#8203;2514]: The `--no-diff` flag will completely disable diff output ([@&#8203;CapacitorSet])
- [#&#8203;3058]: All "setters" in Mocha's API are now also "getters" if called without arguments ([@&#8203;makepanic])
#### 📖 Documentation

- [#&#8203;3170]: Optimization and site speed improvements ([@&#8203;Munter])
- [#&#8203;2987]: Moved the old [site repo](https://github.com/mochajs/mochajs.github.io) into the main repo under `docs/` ([@&#8203;boneskull])
- [#&#8203;2896]: Add [maintainer guide](https://github.com/mochajs/mocha/blob/master/MAINTAINERS.md) ([@&#8203;boneskull])
- Various fixes and updates ([@&#8203;xxczaki], [@&#8203;maty21], [@&#8203;leedm777])
#### 🔩 Other

- Test improvements and fixes ([@&#8203;eugenet8k], [@&#8203;ngeor], [@&#8203;38elements], [@&#8203;Gerhut], [@&#8203;ScottFreeCode], [@&#8203;boneskull])
- Refactoring and cruft excision ([@&#8203;38elements], [@&#8203;Bamieh], [@&#8203;finnigantime], [@&#8203;boneskull])

[#&#8203;2661]: `mochajs/mocha#2661
[#&#8203;3142]: `mochajs/mocha#3142
[#&#8203;3075]: `mochajs/mocha#3075
[#&#8203;2745]: `mochajs/mocha#2745
[#&#8203;2514]: `mochajs/mocha#2514
[#&#8203;3058]: `mochajs/mocha#3058
[#&#8203;3170]: `mochajs/mocha#3170
[#&#8203;2987]: `mochajs/mocha#2987
[#&#8203;2896]: `mochajs/mocha#2896
[@&#8203;canoztokmak]: https://github.com/canoztokmak
[@&#8203;Bamieh]: https://github.com/Bamieh
[@&#8203;abrady0]: https://github.com/abrady0
[@&#8203;Zarel]: https://github.com/Zarel
[@&#8203;CapacitorSet]: https://github.com/CapacitorSet
[@&#8203;xxczaki]: https://github.com/xxczaki
[@&#8203;maty21]: https://github.com/maty21
[@&#8203;leedm777]: https://github.com/leedm777
[@&#8203;eugenet8k]: https://github.com/eugenet8k
[@&#8203;38elements]: https://github.com/38elements
[@&#8203;Gerhut]: https://github.com/Gerhut
[@&#8203;finnigantime]: https://github.com/finnigantime

---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).
This was referenced Sep 22, 2018
Closed
Closed
Open
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Open
Closed
This was referenced Sep 23, 2018
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Oct 2, 2018
Closed
Closed
Closed
Open
This was referenced Oct 31, 2018
Closed
Closed
Merged
This was referenced Nov 12, 2018
Merged
Closed
Merged
Closed
@renovate renovate bot mentioned this issue Nov 23, 2018
Merged
This was referenced Dec 1, 2018
Closed
Merged
Merged
This was referenced Dec 8, 2018
Closed
Merged
This was referenced Dec 23, 2018
Closed
Closed
sgilroy pushed a commit to TwineHealth/mocha that referenced this issue Feb 27, 2019
@boneskull
migrate mochajs.github.io into mocha; closes mochajs#2987 [ci skip]
8dd967c 
- some jekyll tweaks were needed; we can no longer consume the
  `github-pages` gem apparently since they added support for themes
- added `markdown-toc` dev dep to build the toc
- added `buildDocs` and `serveDocs` scripts
- miraculously avoided monkeying with the content itself

Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
sgilroy pushed a commit to TwineHealth/mocha that referenced this issue Feb 27, 2019
@boneskull
merge mochajs.github.io into mocha under docs/; closes mochajs#2987
334a180 
Merge branch 'issue/2987-docs'

* issue/2987-docs: (272 commits)
  update node/npm requirements [ci skip]
  Mocha Sidebar: capitalization tweaks + remove huge gif [ci skip]
  Mocha Sidebar: fix wording [ci skip]
  add mocha side bar as extension for vs code [ci skip]
  update parameter order of example assert [ci skip]
  Improve description of --check-leaks option [ci skip]
  Update 'Arrow Function' wording for clarity. [ci skip]
  fix Gemfile [ci skip]
  migrate mochajs.github.io into mocha; closes mochajs#2987 [ci skip]
  move everything into docs/ in prep for moving repo into mocha proper
  Fix hyperlink for async_hooks
  add section on --exit / --no-exit
  update "Usage" and "--compilers" sections
  Fix typo in "Using async / await" snippet
  Update index.md
  Add `--inspect`
  **Bug** Edge renders the icon for a backer without an image to take up the entire screen.
  drop shx dependency
  chore(package): update shx to version 0.2.0
  fix hardcoded scheme in anchor.js url
  ...

# Conflicts:
#	.gitignore
@snyk-bot snyk-bot mentioned this issue Feb 23, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@boneskull boneskull

Labels
area: documentation anything involving docs or mochajs.org area: repository tooling concerning ease of contribution
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@boneskull @dasilvacontin @ScottFreeCode