Comments (7)
Hey all! We were discussing this in our Slack today and figured one way to go is to create an empty template and user can work from there. We can rewrite My First Jina App accordingly.
I've already created the template (I didn't see this thread before - whoops!) but I'm more than happy for @atibaup to handle rewriting the doc itself
from docs.
Hey @atibaup! We had quite a few users facing difficulty with our My First Jina App as it was written, so I took the matter on as urgent. It's pretty much done for now, and the doc and template are fully done and dusted.
We are looking at writing a lot of other tutorials for learning Jina though. I suggest you join our Slack community and talk to us on the documentation channel there. That might prove faster than doing so here
from docs.
Hi @Yongxuanzhang - I'm following the tutorial and will be happy to take on this issue, but I'm not sure I understand the problem.
I see that the jina hub
command uses the cookiecutter template to create a new app:
But in this issue title you say that cookiecutter is going to be removed, and that we can use the code in the https://github.com/jina-ai/examples/tree/master/wikipedia-sentences example instead.
Do you mean that you would like the first app tutorial to not rely on jina hub new
at all, and that the tutorial should reproduce the code in https://github.com/jina-ai/examples/tree/master/wikipedia-sentences instead?
Thanks :)
from docs.
Hi @atibaup, thank you so much for taking this issue!
Yes, that's what I mean.
There are two ways:
- Fully update the template in cookiecutter to make it consistent with our doc;
- Remove the cookiecutter part in doc, and instead refer to the code in the example repo
I would prefer the 2).
One reason is cookiecutter will not be used in the future (replaced by another one), and another is I think the code in example is easier to maintain.
We can wait for other people's comments. 😄
@FionnD @alexcg1 @deepankarm
from docs.
Hi! Apologies for slow response - been super busy these days! I'll check the template as @alexcg1 suggests and will attempt to rewrite the docs. Thanks!
from docs.
Also - I'd be curious to know why you're deprecating cookiecutter and what other templating tool you plan on using instead?
from docs.
from docs.
Related Issues (20)
- raise a PR to update version after release
- incremental linkcheck
- [Suggestion] Add a new github action to assign the issues. HOT 6
- Explain JinaRuntime HOT 3
- update docs with permanent delete HOT 1
- Update simple-executor section
- Wrong and incomplete documentation about CompundExecutor
- [Suggestion] release process improvements HOT 2
- [improvement] changing link for issue creation HOT 1
- [Suggestion] Expand learning tutorials
- `EncodeDriver` will only work on images if they have the same shape. HOT 6
- JinaD docs are outdated
- jina batching docs needs to be updated after refactor HOT 1
- Add explanation how to add drivers to .YAML
- BaseUpdateDriver HOT 4
- Minimum working example...isn't? HOT 1
- Introduction section is a scary wall of text
- Create a Jina Tutorial HOT 1
- Adjust CI/CD pipeline with 2.0 changes
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 docs.