apify / apify-docs Goto Github PK
View Code? Open in Web Editor NEWThis project is the home of Apify's documentation.
Home Page: https://docs.apify.com
License: Apache License 2.0
This project is the home of Apify's documentation.
Home Page: https://docs.apify.com
License: Apache License 2.0
Based on https://app.zenhub.com/workspaces/platform-team-5f6454160d9f82000fa6733f/issues/apify/apify-web/599
Search is used by 30% of visitors, so we need to know how effective it is for them
Should be able to reuse the code from the docs anchor tag logic or the one from the Covid page
It's quite a mess to have it in the top-level directory. Also, add this README to the new dir:
This directory contains a source file for Apiary
API reference (https://docs.apify.com/api).
It is automatically uploaded to Apiary during web deployment process.
## Local testing
1. Install Apiary gem `gem install apiaryio`
2. After that you can can open generated doc with command: `apiary preview --path="./api-v2-reference.apib"`
### Test
You should ALWAYS log in to Apiary, analyze the document and make sure there are no warnings!
Seems CSS gives all h2, h3, h4 and maybe more (but haven't crossed any) headings padding-top: 80px;
property, which seems to cause overlapping of links in the end of previous paragraph making them non-clickable.
Examples:
https://docs.apify.com/scraping#web-scraper link Visit the Scraper introduction tutorial to get started!
https://docs.apify.com/scraping/getting-started#webhooks link which you can find under your plan
Info about consistency: https://aws.amazon.com/s3/consistency/
Amazon S3 provides strong read-after-write consistency for PUTs and DELETEs of objects in your Amazon S3 bucket in all AWS Regions. This applies to both writes to new objects as well as PUTs that overwrite existing objects and DELETEs. In addition, read operations on Amazon S3 Select, Amazon S3 Access Control Lists, Amazon S3 Object Tags, and object metadata (e.g. HEAD object) are strongly consistent.
Update location: https://docs.apify.com/storage/key-value-store#data-consistency
Requested by Lukas K
https://apifier.slack.com/archives/CMXTZ3VLG/p1611142585006500
https://github.com/DavidAnson/markdownlint#rules--aliases
A good way to ensure consistency and adherence to the style guide!
Also, for example, enforcing highlighting in bold rather than italic (consistency + sketchy markdown rendering of full stops means sometimes consequent italic phrases get messed up)
Also make sure code like ({ content }) has spaces on either side
There is a lot of edits, and now that we want to start working on docs revamp, it would be better to split this content into two separate repos.
@m-murasovs commented on Mon Jan 18 2021
Include info about API docs/blueprint/external docs like actor-scraper
Mention that images should be run through tinypng.com for compression
Articles:
Scraping a list of URLs from a Google Sheets document
How to log in to a website using Puppeteer
Run actor/task and retrieve data via API
List fo articles here https://docs.google.com/spreadsheets/d/136TUwG-V8d5nAWnOiodL1ol_gDYZ3340FivkBYn4Zys/edit#gid=0
It is hard to recognize level of individual headings.. the bold font of Parameters (see Before picture) takes away attention from deleteRecord which is supposed to be a heading for the section
Increasing the font-weight on headings could solve the issue (see After picture).. font-weight: 600 on the pic
Ongoing task; this is just a reminder to do it
List of articles:
https://docs.google.com/spreadsheets/d/136TUwG-V8d5nAWnOiodL1ol_gDYZ3340FivkBYn4Zys/edit#gid=0
As it turns out, most of the articles marked for 'Scraping 101' section are more tutorial-based, so they'll be moved to more tutorial-centric sections.
Other articles and will be moving as and when possible
Search for Now that the run has SUCCEEDED, click on the rightmost card labeled Clean items
. This card was renamed to Results
for example.
We need to review them completely.
This package https://github.com/eslint/eslint-plugin-markdown allows to make sure that code examples in markdown files are linted.
Otherwise, both the markdown and JS linters ignore these files.
This will involve:
We have a request for more frameworks/languages in the proxy docs revamp page:
https://www.notion.so/apify/Proxy-bf9502bee40846b48b42bc0d294752a1
From Slack bug report https://apifier.slack.com/archives/C0L33UM7Z/p1605807674034000
Merge it into one page, add missing content (ask Lukas, etc.) and update to reflect the recent changes (store in app, tasks under actors, ...)
https://app.intercom.com/a/apps/kod1r788/articles/articles/1961361/show?language=en
As requested by Lucka
Rate limits are documented in API docs https://docs.apify.com/api/v2#/introduction/rate-limiting
Based on the New Docs Structure file https://www.notion.so/apify/Actors-fffffa2c645448b3b90a4017a9f96f68
We have State persistence docs, but they don't mention any of the important aspects of migrations. The example is not helpful at all because it's only an example on how to save stuff to key-value store. It's also outdated and too long for what it does.
We need to add:
migration
and persistState
events in the SDK that you can listen toOn every commit, the tests can run to check stuff like description lengths, maybe keyword stuffing (would be cool), if image sizes are decent, if the metadata is right, etc.
Currently tests are in src/build and src/parser, plus a lint test, so we could move them to a Jest file, then run that test file from github/workflows
There is currently a short intro to apify on the homepage (changing in https://app.zenhub.com/workspaces/platform-team-5f6454160d9f82000fa6733f/issues/apify/apify-web/429), which would be nice to keep.
I'll add a new section in Docs, which we can then extend with Apify vocabulary, etc.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.