Skip to content

Deduplicating docs with har.fyi#875

Merged
rviscomi merged 13 commits intoHTTPArchive:mainfrom
max-ostapenko:migrate-docs
Jul 15, 2024
Merged

Deduplicating docs with har.fyi#875
rviscomi merged 13 commits intoHTTPArchive:mainfrom
max-ostapenko:migrate-docs

Conversation

@max-ostapenko
Copy link
Copy Markdown
Contributor

@max-ostapenko max-ostapenko commented Jun 9, 2024

I started working on query migration guide, and found that this repo and har.fyi have a few duplicated docs.
As har.fyi is a bit better looking than Github files, here is an idea to improve this a bit.

Move to har.fyi:

  • docs/guided_tour.md
  • docs/gettingstarted_bigquery.md
  • docs/guided_tour_summary_pages.md
  • docs/guided_tour_summary_requests.md
  • docs/guided_tour_summary_pages_requests.md

I think it may be useful to keep the version of the guide here while multiple types of tables are maintained.

Maintenance and visitor docs that make sense to keep in this repo as dev documentation:

  • docs/reports.md
  • docs/faq.md
  • docs/cwv_tech_report.md

This should make it a bit more straightforward for new analysts, make maintenance easier.

P.S> If there are any other docs to take into consideration, please comment.

@max-ostapenko max-ostapenko marked this pull request as ready for review June 21, 2024 13:38
Copy link
Copy Markdown
Member

@rviscomi rviscomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no overview page on har.fyi yet, did you mean to mark this as ready for review?

@max-ostapenko max-ostapenko marked this pull request as draft June 21, 2024 13:45
@max-ostapenko
Copy link
Copy Markdown
Contributor Author

@rviscomi sorry, still not ready.
Wanted to break it into 2 PRs:

  • deduplication
  • migration to all

but too many interdependencies.

@max-ostapenko
Copy link
Copy Markdown
Contributor Author

@rviscomi now ready.
You may find guides overview page in this PR.

@max-ostapenko max-ostapenko marked this pull request as ready for review June 22, 2024 21:57
@rviscomi rviscomi merged commit 08f7f53 into HTTPArchive:main Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants