Comments (17)
Still open merge this with master.
Add a new README.md that links to the documentation and to the markdown pages.
Perhaps we should talk to @dr0i and @fsteeg if they are okay with the remodelling of the documentation repo.
from metafacture-documentation.
functional review: @TobiasNx
code review: ?
from metafacture-documentation.
As discussed today we will ask if @Phu2 has time to give it a try.
from metafacture-documentation.
Note to self: the docs are published as github pages already, see https://metafacture.github.io/metafacture-documentation/ However, the metafacture site oddly links to the (this!) repo of the docs instead.
from metafacture-documentation.
Note to self: the docs are published as github pages already, see https://metafacture.github.io/metafacture-documentation/ However, the metafacture site oddly links to the (this!) repo of the docs instead.
This is due to the fact that the gh pages version is not ready yet / did not exist yet and the documentation repo was used instead.
from metafacture-documentation.
First draft is published at https://phu2.github.io/metafacture-documentation/
Still need to adjust the navigation and tweak some colors.
The site will be re-deployed on push to the master branch of https://github.com/Phu2/metafacture-documentation
from metafacture-documentation.
Structure:
General pages:
- Readme
- Getting Started
- 5 min Intro into MF
- Approaching a transformation with metafacture
FLUX
- Flux User Guide
- Flux Commands
FIX
- Fix-User-Guide
- Fix Functions and Cookbook
Java Integration
- Framework user guide
For Developers
- Documentation-Maintainer-Guide
- License
from metafacture-documentation.
Pages restructered, navigation added.
@TobiasNx You might want to review the redeployed docs https://phu2.github.io/metafacture-documentation/
- the
README.md
is left as is for use within the repo - parts of the
README.md
were copied toindex.md
(Home),flux.md
,fix.md
and so on - there is no "For Developers" level for now, might add later if needed
- the
LICENSE
file is replicated asLICENSE.md
for display within the jekyll site
from metafacture-documentation.
TODOs:
- Use the MF blue
- Move the MF Icon to the top left corner
- Some formatting but I am not sure.
If we are done with this, we could invite the team to have a look at this.
from metafacture-documentation.
Done.
I also tried to fix all links and added a footer.
from metafacture-documentation.
"Approaching a transformation with metafacture" isn't linked to anywhere (and has no heading). Same with "Maintainer Guide".
from metafacture-documentation.
'Short cheer here - this looks so much better 👍
from metafacture-documentation.
Perhaps add the word documentation under the logo in the corner?
Also any way to turn [!NOTE] into
Seems like there is a way within justthedocs: https://just-the-docs.com/docs/ui-components/callouts/
from metafacture-documentation.
Also how should we proceed?
from metafacture-documentation.
New branch https://github.com/metafacture/metafacture-documentation/tree/28-use-jekyll-theme created + corresponding Github Action (on push) for deployment to http://metafacture.github.io/metafacture-documentation/
from metafacture-documentation.
The page at http://metafacture.github.io/metafacture-documentation/ looks good to me, but the PR at #43 is still a draft and has not been reviewed (and is not linked to this issue). Shouldn't this go through the regular review process?
from metafacture-documentation.
The page at http://metafacture.github.io/metafacture-documentation looks good to me, but the PR at #43 is still a draft and has not been reviewed (and is not linked to this issue). Shouldn't this go through the regular review process?
I opened an PR for this and assigned you for review.
from metafacture-documentation.
Related Issues (20)
- use of collect / count and sort triple commands HOT 4
- metamorph: use and combination of reset, flushWith and sameEntity attributes HOT 3
- Metamorph: remove duplicates from array HOT 2
- New morph function "UrlEscaper" implementing RFC 3986 HOT 1
- Examination of documentation status HOT 4
- Create new Functions and Collector Documentation HOT 2
- Highlight signature of flux-commands HOT 2
- Command `template` description is wrong? HOT 1
- Delete prettyPrinting option for encode-yaml in documentation HOT 7
- Add documentation that decode-marc21 needs UTF-8 encoding HOT 2
- Improve documentation with regard to fix HOT 3
- Encoding problems in MF-in-5-min playground example HOT 5
- Missing description for flux command wait-for-input HOT 2
- Blog about new flux-commands HOT 2
- Move Fix Playbook-Part into Fix User Guide
- Adding links to Java Code of Fix Functions HOT 1
- Add link to PG for "list-fix-paths" (and some more if you feel like it) HOT 1
- Add CONTRIBUTING.md
- Add proxy for metafacture.org/documentation HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from metafacture-documentation.