8000 DOC-309 | Remove DocuBlocks and obsolete documentation tooling by Simran-B · Pull Request #19758 · arangodb/arangodb · GitHub
[go: up one dir, main page]
Skip to content

DOC-309 | Remove DocuBlocks and obsolete documentation tooling #19758

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Sep 15, 2023
Merged

DOC-309 | Remove DocuBlocks and obsolete documentation tooling #19758

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
33d4ad9
Remove Rest DocuBlocks
Simran-B Sep 12, 2023
f9c213d
Remove Books and Examples placeholder folders
Simran-B Sep 12, 2023
923c78f
Remove scripts
Simran-B Sep 12, 2023
e43f609
Update link to docs repo
Simran-B Sep 12, 2023
69543e2
Docs: Add instructions for building api-docs.json with the new Docker…
Simran-B Sep 14, 2023
fcbb019
Misc cleanup, handle some of the doc links
Simran-B Sep 14, 2023
7dc4195
Merge branch 'devel' of https://github.com/arangodb/arangodb into rem…
Simran-B Sep 14, 2023
392caca
Remove DocuBlock code comments
Simran-B Sep 14, 2023
a9a46b8
CHANGELOG entry
Simran-B Sep 14, 2023
1604ac6
Re-add accidentally removed line
Simran-B Sep 14, 2023
fac008e
Merge branch 'devel' into remove-docublocks
Simran-B Sep 15, 2023
a9b4ec5
Merge branch 'devel' into remove-docublocks
Simran-B Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Misc cleanup, handle some of the doc links 
The remaining links are covered by redirects for the time being
  • Loading branch information
@Simran-B
Simran-B committed Sep 14, 2023
commit fcbb019af74c470a82c59f7088ef87bb4bcaf31e
2 changes: 0 additions & 2 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
# `documentation-team` ownership
/Documentation/ @arangodb/team-documentation
/utils/*Documentation* @arangodb/team-documentation
/utils/*Examples* @arangodb/team-documentation
/utils/*Swagger* @arangodb/team-documentation

# `qa-team` ownership
/Installation/ @arangodb/team-qa
Expand Down
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ npm-debug.log
data-*
databases
!js/apps/system/_admin/aardvark/APP/react/src/views/databases
!/Documentation/DocuBlocks/Rest/Databases
cluster-init

datafile-*.db
Expand Down
2 changes: 0 additions & 2 deletions CHANGELOG
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9512,8 +9512,6 @@ v3.5.0-rc.1 (2019-05-14)
- `--javascript.endpoints-whitelist`: control accessible endpoints in JavaScript
- `--javascript.files-whitelist`: control file access in JavaScript

Note: There is a [detailed description of all options](https://www.arangodb.com/docs/devel/security-security-options.html).

* Prevented arangod from making a call to www.arangodb.com at startup.

This call was done to check for available updates, but it could have contributed
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ set(ARANGODB_PACKAGE_VENDOR "ArangoDB GmbH")
set(ARANGODB_PACKAGE_CONTACT "info@arangodb.com")
set(ARANGODB_DISPLAY_NAME "ArangoDB")
set(ARANGODB_URL_INFO_ABOUT "https://www.arangodb.com")
set(ARANGODB_HELP_LINK "https://www.arangodb.com/docs/${ARANGODB_VERSION_MAJOR}.${ARANGODB_VERSION_MINOR}/")
set(ARANGODB_HELP_LINK "https://docs.arangodb.com/${ARANGODB_VERSION_MAJOR}.${ARANGODB_VERSION_MINOR}/")
set(ARANGODB_CONTACT "hackers@arangodb.com")
set(ARANGODB_FRIENDLY_STRING "ArangoDB - the native multi-model NoSQL database")

Expand Down
6 changes: 3 additions & 3 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Getting Started
- [ArangoDB University](https://university.arangodb.com/)
- [Free Udemy Course](https://www.udemy.com/course/getting-started-with-arangodb)
- [Training Center](https://www.arangodb.com/learn/)
- [Documentation](https://www.arangodb.com/docs/stable/)
- [Documentation](https://docs.arangodb.com/)

For the impatient:

Expand Down Expand Up @@ -98,8 +98,8 @@ Latest Release
Packages for all supported platforms can be downloaded from
<https://www.arangodb.com/download/>.

For what's new in ArangoDB, see the [Highlight by Version](https://www.arangodb.com/docs/stable/highlights.html)
and the [Release Notes](https://www.arangodb.com/docs/stable/release-notes.html).
For what's new in ArangoDB, see the Release Notes in the
[Documentation](https://docs.arangodb.com/).

Stay in Contact
---------------
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Getting Started
- [ArangoDB University](https://university.arangodb.com/)
- [Free Udemy Course](https://www.udemy.com/course/getting-started-with-arangodb)
- [Training Center](https://www.arangodb.com/learn/)
- [Documentation](https://www.arangodb.com/docs/stable/)
- [Documentation](https://docs.arangodb.com/)

For the impatient:

Expand Down Expand Up @@ -104,8 +104,8 @@ Latest Release
Packages for all supported platforms can be downloaded from
<https://www.arangodb.com/download/>.

For what's new in ArangoDB, see the [Highlight by Version](https://www.arangodb.com/docs/stable/highlights.html)
and the [Release Notes](https://www.arangodb.com/docs/stable/release-notes.html).
For what's new in ArangoDB, see the Release Notes in the
[Documentation](https://docs.arangodb.com/).

Stay in Contact
---------------
Expand Down
2 changes: 1 addition & 1 deletion js/client/modules/@arangodb/tutorial.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ var lessons = [
'Wrapping multi-line queries in backticks is the most convenient way in\n' +
"today's JavaScript.\n\n" +
'See our online documentation for more details on AQL:\n' +
'https://www.arangodb.com/docs/stable/'
'https://docs.arangodb.com/'
},
{
title: 'Using Databases',
Expand Down
0